openedx / openedx/docs.openedx.org
Update i18n coding guidelines with additional examples
Open
Nobody has claimed this yet.
developers
i18n
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
On https://docs.openedx.org/en/latest/developers/references/developer_guide/internationalization/i18n.html update this guide that describe why not to use the pattern that's used here:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the i18n coding guide at docs.openedx.org/en/latest/developers/references/developer_guide/internationalization/i18n.html, then inspect the referenced pattern in common/djangoapps/student/views/management.py around line 529. Update the guide with additional examples and an explanation of why that pattern should not be used; the documentation should clearly cover the intended alternative.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, internationalization
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100