When a release goes live, we publish release notes and other documents by running new builds on readthedocs. To actually change the release date that appears on the docs.edx.org page, you need to update an HTML file in edx-platform.
Step-by-step guide
(Original instructions follow these in case they're helpful as well. These steps created after a quick demo from btalbotR (Deactivated).)
- Check out the edx-platform "gh-pages" branch (not master) (aka: select this branch and sync).
Note: If you're using the command line, after you check out gh-pages, you may have to run "git pull" to update the branch. - In Finder, navigate to edx-platform/index.html and open index.html in Sublime or your preferred editing tool.
- Search the file for the last release date and update it to the current release date. (The date only appears once in the file.)
- Save and then commit and sync (or "push", if you're using the command line) your branch. (You don't need to make a pull request.)
- Check the docs.edx.org page to make sure that the date gets updated within a few minutes.
Original instructions:
Detailed GitHub instructions for Documentation Team
Clone the edx_platform gh-pages branch locally:git clone -b gh-pages git@github.com:edx/edx-platform.git
CD to directory where you cloned gh-pagesCheckout gh-pages:git checkout gh-pages
Check out the new branch branch:git checkout -b release-notes/date
Make changes to the release notes files and index.html as needed.Check that the file changes you made are properly reflected by running:git status
Add new or changed files to Git:git add filename
Commit the files to the new branch:git commit -m 'release notes update for date'
Push the changes:git push --set-upstream origin release-notes/date
Go to the edx_platform project in GitHub, select the gh-pages branch, and create a pull request from the release-notes/date branch you created.A second member of the Documentation team will review and merge changes to the gh-pages branch.