To update the edX documentation home page at docs.edx.org, you need to update an HTML file in the edx-platform
repository.
Step-by-step guide
- In the
edx-platform
repository, check out thegh-pages
branch (not master).
Note: If you're using the command line, after you check outgh-pages
, you may have to rungit pull
to update the branch. - In Finder, navigate to
edx-platform/index.html
and openindex.html
in Sublime or your preferred editing tool. - After you have made your edits, save, commit and push your branch. You don't need to make a pull request. Your edits go live without any further action.
- Check the docs.edx.org page after a few minutes to make sure that your updates have been published.