openedx / openedx/openedx-platform
Docs: "HOMEPAGE_COURSE_MAX" lacks documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Hi everyone,
I see this feature/config option HOMEPAGE_COURSE_MAX has existed in the base code for a very long time, however it seems to lack documentation.
I suppose it might be best fitting for this to be added in settings.html ?
Here is reference to a community post in which a user was looking for documentation related to this config: https://discuss.openedx.org/t/front-page-limit-number-of-displayed-courses/17450
Thank you
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
Read lms/envs/common.py at the HOMEPAGE_COURSE_MAX definition, then review the existing structure of docs/.../references/settings.html. Add an entry explaining this configuration option, with enough detail for users to understand its purpose and usage; the work is done when the setting is documented in the settings reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100