From b670bc180974c1e9f54cf80251e7faf1e5fc292c Mon Sep 17 00:00:00 2001 From: Naomi Slater Date: Mon, 17 Jul 2017 16:20:32 +0200 Subject: [PATCH] add note about archiving docs --- DEVELOP.rst | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/DEVELOP.rst b/DEVELOP.rst index 2e0e2465..675c10d8 100644 --- a/DEVELOP.rst +++ b/DEVELOP.rst @@ -66,8 +66,12 @@ To create a new release, you must: - Create a tag by running ``./devtools/create_tag.sh`` +- Deploy to PyPI (see section below) + +- Archive docs for old releases (see section below) + PyPI Deployment -=============== +--------------- To create the package use:: @@ -96,6 +100,33 @@ If you want to check the PyPI description before uploading, run:: $ bin/py setup.py check --strict --restructuredtext +Archiving Docs Versions +----------------------- + +Check the `versions hosted on ReadTheDocs`_. + +We should only be hosting the docs for `latest`, `stable`, and the most recent +patch versions for the last two minor releases. + +Here's an example: + +- latest +- stable +- 0.21.3 +- 0.20.1 + +Here's what you might do: + +- If you were releasing g0.22.0, you would archive 0.20.1 +- If you were releasing 0.21.4, you would archive 0.21.3 +- If you were releasing 0.20.2, you would archive 0.20.1 + +Sometimes you might find that there are multiple older releases that need to be +archived. + +You can archive releases by selecting *Edit*, unselecting the *Active* +checkbox, and then saving. + Standalone Deployment ===================== @@ -126,3 +157,4 @@ nothing special you need to do to get the live docs to update. .. _tox: http://testrun.org/tox/latest/ .. _twine: https://pypi.python.org/pypi/twine .. _zope.testrunner: https://pypi.python.org/pypi/zope.testrunner/4.4.1 +.. _versions hosted on ReadTheDocs: https://readthedocs.org/projects/crash/versions/