diff --git a/pep-0101.txt b/pep-0101.txt index b489e9292..c34c59a22 100644 --- a/pep-0101.txt +++ b/pep-0101.txt @@ -305,21 +305,14 @@ to perform some manual editing steps. release tag in the repo is signed with your gpg key. When prompted choose the private key you use for signing release tarballs etc. -- For a **new branch** release, ``Doc/tools/static/switchers.js`` - must be updated in all maintained branches, so that the new maintenance - branch is now ``pre`` (for ``pre-release``) and add the new "dev" version. - Also, update ``Doc/tools/templates/indexsidebar.html`` to - increment the version number of the ``in development`` version - and add an entry under it for the new release branch with ``pre-release`` - status. Review the remaining branch entires and consider removing the - oldest ``security-fixes`` branch. - Also, similar changes must be made and committed to these files in all - of the other active branches. Or ask the DE to do this. +- For a **new branch** release, add it to the ``VERSIONS`` list of + `docsbuild scripts`_, so that the new maintenance branch is now + ``pre-release`` and add the new ``in development`` version. -- For a **final** major release, ``Doc/tools/static/switchers.js`` - and ``Doc/tools/templates/indexsidebar.html`` - must be updated in all maintained branches, changing the release branch - from ``pre-release`` to ``stable``. +- For a **final** major release, update the ``VERSIONS`` list of + `docsbuild scripts`_: the release branch must be changed from + ``pre-release`` to ``stable``, tell the DE to update the ``/3/`` + symlink. - For **begin security-only mode** and **end-of-life** releases, review the two files and update the versions accordingly in all active branches. @@ -391,7 +384,7 @@ to perform some manual editing steps. - The WE has one checkout tree per target architecture, and builds the pcbuild.sln project for the appropriate architecture. - - PC\icons.mak must have been run with nmake. + - PC\\icons.mak must have been run with nmake. - The cmd.exe window in which this is run must have Cygwin/bin in its path (at least for x86). @@ -454,19 +447,13 @@ to perform some manual editing steps. unpack the HTML docs to ``/srv/docs.python.org/release/X.Y.Z[rcA]`` on docs.nyc1.psf.io. Make sure the files are in group ``docs`` and are group-writeable. If it is a release of a security-fix-only version, - tell the DE to build a version with the "version switcher" - and put it there. + tell the DE to start a build (``security-fixes`` and ``EOL`` version + are not built daily). - Let the DE check if the docs are built and work all right. - If this is a **final** major release: Tell the DE to adapt redirects for - docs.python.org/X.Y in the nginx config for docs.python.org, update - the `docsbuild-scripts `_ - to point to the right stable/development branches, and to install it - and make the initial checkout. - The Doc's ``switchers.js`` script also needs to be - updated. In general, please don't touch things in the toplevel - ``/srv/docs.python.org/`` directory unless you know what you're doing. + docs.python.org/X.Y in the nginx config for docs.python.org. - Note both the documentation and downloads are behind a caching CDN. If you change archives after downloading them through the website, you'll @@ -895,10 +882,8 @@ else does them. Some of those tasks include: - Optionally making a final release to publish any remaining unreleased changes. -- Check the `docsbuild server script - `_ - to ensure that the docs set for the branch is no longer being built. - If still present, ask the DE to remove this branch from the BRANCHES list. +- Update the ``VERSIONS`` list of `docsbuild scripts`_: change the + version state to ``EOL``. - On the docs download server (docs.nyc1.psf.io), ensure the top-level symlink points to the upload of unpacked html docs from final release:: @@ -907,17 +892,6 @@ else does them. Some of those tasks include: ls -l 3.3 lrwxrwxrwx 1 nad docs 13 Sep 6 21:38 3.3 -> release/3.3.7 -- In each unretired cpython branch, remove any remaining references to the - retired branch in the Doc version switcher and side bar templates - (file names may vary between branches) [DE]:: - - Doc/tools/static/switchers.js - Doc/tools/templates/indexsidebar.html - - Note that the best way to do this is to make the change in the current - `master` branch, then backport to the other active branches. (This will - hopefully pacify the current state-of-the-art nannybots.) - - Freeze the state of the release branch by creating a tag of its current HEAD and then deleting the branch from the cpython repo. The current HEAD should be at or beyond the final security release for the branch:: @@ -1019,6 +993,9 @@ Copyright This document has been placed in the public domain. +.. _docsbuild scripts: + https://github.com/python/docsbuild-scripts/blob/master/build_docs.py + .. Local Variables: mode: indented-text