What needs to be improved?
https://docs.modx.com/current/en/getting-started/glossary
After working on updating system variables, the following idea came to my mind - it would be great to have some kind of "starting point" where original terms used in the system would be. We have Glossary, but it seems many terms don't exist at all, while others require renovation/updating.
As soon as it is updated, it'll be good to update accordingly, for example, the Russian glossary (and other translations). It is very useful to have it at hand when you are doing translations and there is a double interpretation - I also saw in Crowdin's lexicons that one and the same entity has similar but still different names.
What I would like to do:
- Alphabetical order
- Links from term to appropriate documentation page (the title itself could be a link .. or use something like "more..." )
- Add more clickable synonyms to Glossary (they were) - example: getting-started/glossary#document-identifier
- More links inside the Glossary page itself, for example:
Content Type
Sets the extension, mime-type and binary setting for any Resource. The same for "Extension"(exists) and Mime-type(absent, can be added.)
"Resource" here should be the link to anchor below for "Resource" term
- Add more general terms to Glossary that are also found in the documentation (Session, Database, etc.) so that ordinary user does not need to look for the definition elsewhere.
- for all Glossary terms in the documentation use the naming with a capital letter - Chunk, Template, Installer, etc.(this is observed mostly in the English version, but is lost in the Russian version), at the beginning of the documentation (or the section "see also") provide such terms with a link to the glossary and / or corresponding documentation page.
- here is a list of some terms that I would also like to add / actualize (this is what I came across in the documentation):
I think it is important to do this first since the updating of any other pages should go with an eye to the Glossary. I would be glad to receive your comments. Ready to start soon. @Mark-H @Ibochkarev
What needs to be improved?
https://docs.modx.com/current/en/getting-started/glossary
After working on updating system variables, the following idea came to my mind - it would be great to have some kind of "starting point" where original terms used in the system would be. We have Glossary, but it seems many terms don't exist at all, while others require renovation/updating.
As soon as it is updated, it'll be good to update accordingly, for example, the Russian glossary (and other translations). It is very useful to have it at hand when you are doing translations and there is a double interpretation - I also saw in Crowdin's lexicons that one and the same entity has similar but still different names.
What I would like to do:
Content Type
Sets the extension, mime-type and binary setting for any Resource. The same for "Extension"(exists) and Mime-type(absent, can be added.)
"Resource" here should be the link to anchor below for "Resource" term
....to be continued....
I think it is important to do this first since the updating of any other pages should go with an eye to the Glossary. I would be glad to receive your comments. Ready to start soon. @Mark-H @Ibochkarev