Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unify the dev guide + dev glossaries #433

Merged
merged 2 commits into from
Nov 27, 2023
Merged

Unify the dev guide + dev glossaries #433

merged 2 commits into from
Nov 27, 2023

Conversation

sarina
Copy link
Contributor

@sarina sarina commented Nov 15, 2023

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
Copy link
Contributor

feanil commented Nov 16, 2023

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

@sarina sarina force-pushed the unified-dev-glossary branch from 9b127c1 to bbb2c11 Compare November 17, 2023 03:23
@sarina
Copy link
Contributor Author

sarina commented Nov 17, 2023

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!

@feanil feanil requested a review from farhan November 20, 2023 15:33
@sarina sarina merged commit 8e5cd4e into main Nov 27, 2023
@sarina sarina deleted the unified-dev-glossary branch November 27, 2023 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants