summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@nvidia.com>2021-11-09 21:12:37 +0100
committerQuentin Young <qlyoung@nvidia.com>2021-11-09 21:12:37 +0100
commitb7ca0bc3609bfbe0c3f5bd69f51beb8e4ef2bc15 (patch)
treed5e4f536232de73a5cc8f683ab494969e4f560b4
parentdoc: use sphinx auto-numbering in release docs (diff)
downloadfrr-b7ca0bc3609bfbe0c3f5bd69f51beb8e4ef2bc15.tar.xz
frr-b7ca0bc3609bfbe0c3f5bd69f51beb8e4ef2bc15.zip
doc: update docs details in release procedure
Signed-off-by: Quentin Young <qlyoung@nvidia.com>
-rw-r--r--doc/developer/frr-release-procedure.rst10
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/developer/frr-release-procedure.rst b/doc/developer/frr-release-procedure.rst
index 3e2eb2465..8153f00fa 100644
--- a/doc/developer/frr-release-procedure.rst
+++ b/doc/developer/frr-release-procedure.rst
@@ -144,8 +144,14 @@ FRR Release Procedure
#. Deploy Snapcraft release (after CI system finishes the tests for snapcraft
testplan).
-#. Update the Read The Docs instance to begin publishing documentation built
- off the ``stable/<version>`` branch. Contact Quentin Young for this step.
+#. Log in to the Read The Docs instance. in the "FRRouting" project, navigate
+ to the "Overview" tab. Ensure there is a ``stable-<version>`` version listed
+ and that it is enabled. Go to "Admin" and then "Advanced Settings". Change
+ "Default version" to the new version. This ensures that the documentation
+ shown to visitors is that of the latest release by default.
+
+ This step must be performed by someone with administrative access to the
+ Read the Docs instance.
#. Publish the GitHub release.