Add notes about updating Dash docs

LB (Ben Johnston) 2017-11-16 16:43:55 +07:00
parent 6f23262a35
commit be5a2f98d7
1 changed files with 2 additions and 0 deletions

@ -68,6 +68,8 @@ The new version should now be up on https://pypi.python.org/pypi/wagtail .
* Go to https://readthedocs.org/projects/wagtail/builds/ and republish all versions from 1.8 onward - this will update the 'canonical' URL in the HTML to point to the new version, hopefully preventing old versions from being indexed by Google. (Older versions can no longer be built due to broken dependencies in docs/requirements.txt) * Go to https://readthedocs.org/projects/wagtail/builds/ and republish all versions from 1.8 onward - this will update the 'canonical' URL in the HTML to point to the new version, hopefully preventing old versions from being indexed by Google. (Older versions can no longer be built due to broken dependencies in docs/requirements.txt)
* If any documentation has been moved around since the previous release, now is a good time to add redirects via https://readthedocs.org/dashboard/wagtail/redirects/ . (Protip: [remember to add leading slashes on URLs](https://github.com/rtfd/readthedocs.org/issues/1826#issuecomment-247995569).) * If any documentation has been moved around since the previous release, now is a good time to add redirects via https://readthedocs.org/dashboard/wagtail/redirects/ . (Protip: [remember to add leading slashes on URLs](https://github.com/rtfd/readthedocs.org/issues/1826#issuecomment-247995569).)
* If this is a minor point release, disable the docs for the previous minor release by unticking it on https://readthedocs.org/dashboard/wagtail/versions/ * If this is a minor point release, disable the docs for the previous minor release by unticking it on https://readthedocs.org/dashboard/wagtail/versions/
* Update docs in [Dash-User-Contributions](https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/Wagtail) for offline docs apps [Dash](https://kapeli.com/dash) and [Zeal](https://zealdocs.org/).
* Follow the instructions on the README.md and submit a pull request with updated docs.
## releases.wagtail.io ## releases.wagtail.io