search

openedx / docs.openedx.org

[BETA] A new home for learning about Open edX
https://docs.openedx.org
Other
6 stars 53 forks source link

Unify the dev guide + dev glossaries #433

Closed sarina closed 8 months ago

sarina commented 8 months ago

Currently the developer guide has a pretty comprehensive glossary (https://docs.openedx.org/en/latest/developers/references/developer_guide/glossary.html) and the developer section glossary is lean (https://docs.openedx.org/en/latest/developers/references/glossary.html) - here I unify one glossary, in the Developers section. @feanil what do you think? The glossary probably still needs editing as it has a bunch of edx.org specific stuff, but actually I think keeping a lot of that stuff makes sense as the terms do come up from time to time.

Also converted the dev glossary to a real Sphinx glossary : https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html

feanil commented 8 months ago

The change makes sense to me. Let's get it to green.

sarina commented 8 months ago

Fixed it. Ended up having to rewrite the old glossary in the RST format, but on the plus side it looks better and :term: now works everywhere. Ready for review!