From e9cfb0d9d64b4b5ce89c2dfdd340412f356472bd Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Tue, 18 Oct 2022 09:08:57 -0400 Subject: [PATCH] Remove references to install r6 and r7 Replace pointers to copies of r6 and r7 install docs on master branch with links to content built from branches. Incorp. patchset 1 review comments. Signed-off-by: Ron Stone Change-Id: I94305d66d77d971cddf91e16770e0fea5b7f31a8 --- .../_includes/version-menu-7dda26c5b75f.rest | 1 + ...dex-documentation-archive-900988dce206.rst | 14 +++++++++ .../index-install-e083ca818006.rst | 31 +++++++++---------- .../index-install-r7-8966076f0e81.rst | 14 +++++++-- doc/source/index.rst | 2 +- 5 files changed, 41 insertions(+), 21 deletions(-) create mode 100644 doc/source/_includes/version-menu-7dda26c5b75f.rest diff --git a/doc/source/_includes/version-menu-7dda26c5b75f.rest b/doc/source/_includes/version-menu-7dda26c5b75f.rest new file mode 100644 index 000000000..4a2da97e9 --- /dev/null +++ b/doc/source/_includes/version-menu-7dda26c5b75f.rest @@ -0,0 +1 @@ +To access other supported releases, use the **VERSION** menu above. diff --git a/doc/source/archive/index-documentation-archive-900988dce206.rst b/doc/source/archive/index-documentation-archive-900988dce206.rst index e24b4f1a8..a4a1f9096 100644 --- a/doc/source/archive/index-documentation-archive-900988dce206.rst +++ b/doc/source/archive/index-documentation-archive-900988dce206.rst @@ -4,6 +4,20 @@ Documentation Archive ===================== +.. include:: /_includes/version-menu-7dda26c5b75f.rest + +------------------------------ +Archived Release Documentation +------------------------------ + +Links to older and unmaintained documentation are available here. + +* `Release 5.0 `__ + +-------------------------- +Discontinued Documentation +-------------------------- + .. note:: These guides are deprecated and no longer maintained. Links to replacement diff --git a/doc/source/deploy_install_guides/index-install-e083ca818006.rst b/doc/source/deploy_install_guides/index-install-e083ca818006.rst index 628ba8f7a..9a7c673bb 100644 --- a/doc/source/deploy_install_guides/index-install-e083ca818006.rst +++ b/doc/source/deploy_install_guides/index-install-e083ca818006.rst @@ -12,8 +12,8 @@ Each guide provides instruction on a specific StarlingX configuration Upcoming release ---------------- -The next release will be R8.0. Use the documentation for the R7.0 -installation listed below. +The next release will be R8.0. Use the installation procedures in +:ref:`index-install-r7-8966076f0e81`. --------------- Current release @@ -21,35 +21,32 @@ Current release R7.0 is the current release of StarlingX. -Use the R7.0 Installation Guides to install R7.0. - -.. toctree:: - :maxdepth: 1 - - r7_release/index-install-r7-8966076f0e81 +Use the `R7.0 Installation Guides +`__ +to install R7.0. ------------------ Supported releases ------------------ - -.. toctree:: - :maxdepth: 1 - - r7_release/index-install-r7-8966076f0e81 - r6_release/index-install-r6-8966076f0e81 - +.. include:: /_includes/version-menu-7dda26c5b75f.rest ----------------- Archived releases ----------------- -To view the archived installation guides, see `Installation guides for R5.0 and -older releases `_. +To view the archived installation guides, see +:ref:`index-documentation-archive-900988dce206`. +.. Keep Sphinx happy until these directories are removed +.. toctree:: + :hidden: + + r7_release/index-install-r7-8966076f0e81 + r6_release/index-install-r6-8966076f0e81 .. Add common files to toctree diff --git a/doc/source/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.rst b/doc/source/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.rst index b410becaa..cb4503aaf 100644 --- a/doc/source/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.rst +++ b/doc/source/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.rst @@ -1,8 +1,16 @@ .. _index-install-r7-8966076f0e81: -=========================== -StarlingX R7.0 Installation -=========================== +================================== +Development StarlingX Installation +================================== + +.. note:: + + This Installation guide is for the upcoming release of + |prod|, and is not supported. + + To install the most recent released verion of |prod|, see: + https://docs.starlingx.io/r/stx.7.0/deploy_install_guides/r7_release/index-install-r7-8966076f0e81.html StarlingX provides a pre-defined set of standard :doc:`deployment configurations `. Most deployment options may be diff --git a/doc/source/index.rst b/doc/source/index.rst index 5e83a612f..e512c1cd7 100755 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -222,7 +222,7 @@ details. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 archive/index-documentation-archive-900988dce206