From fc7cdf4af32a4ea6ffb0e1719650d8bb4e460185 Mon Sep 17 00:00:00 2001 From: Edit Koselak Date: Fri, 19 May 2023 14:57:08 +0200 Subject: Updating Installation and fixing the toc.tree Minor editorial changes in User guide Signed-off-by: Edit Koselak Change-Id: Ib0afb05062cc8e5e3c5ad5a61fc51aef258613f0 --- docs/index.rst | 41 +++++++++++++++++++---------------------- 1 file changed, 19 insertions(+), 22 deletions(-) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 30adf1c09..391be47f0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,13 +31,13 @@ projects. Participation is open to anyone, whether you are an employee of a member company or just passionate about network transformation. -Documentation for Anuket Users +Documentation for Anuket users ------------------------------ These documents are targeted to the users of the different Anuket sub-projects and here they are organized by sub-project categories. -Anuket Specifications +Anuket specifications ~~~~~~~~~~~~~~~~~~~~~ :doc:`Anuket Specifications ` provide reference specifications for cloud infrastructures and their @@ -57,6 +57,13 @@ workloads. The specifications are organized to the following documents: * Reference Implementation based on RA2 specifications (RI2) - a blueprint to build a Kubernetes container orchestration platform based on the RA2 specificcations. +.. toctree:: + :maxdepth: 1 + :hidden: + + release/installation.introduction + release/userguide.introduction + release/release-notes Implementation projects ~~~~~~~~~~~~~~~~~~~~~~~ @@ -65,27 +72,20 @@ Implementation projects address specific needs in the cloud technology relevant reuseable implementation. The implementation projects have their release notes, installation and user guides in the aggregated documentation set referred here: -.. toctree:: - :maxdepth: 1 - - release/installation.introduction - release/userguide.introduction - release/release-notes - +- :doc:`Installation Introduction` +- :doc:`User Guide and Configuration Guide` +- :doc:`Release Notes` -Testing Projects and Frameworks +Testing projects and frameworks ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Testing projects, like ViNePERF provide testing tools to assess certain characteristics of cloud infrastructures while the Functest testing framework provides an automatic test suite to test the cloud infrastructures. The testing projects and frameworks have their release notes, installation and user guides in the aggregated documentation set referred here: -.. toctree:: - :maxdepth: 1 - - release/installation.introduction - release/userguide.introduction - release/release-notes +- :doc:`Installation Introduction` +- :doc:`User Guide and Configuration Guide` +- :doc:`Release Notes` Integration projects ~~~~~~~~~~~~~~~~~~~~ @@ -94,12 +94,9 @@ The integration projects integrate OpenStack and Kubernetes based cloud infrastr and RI2. The integration projects have their release notes, installation and user guides in the aggregated documentation set referred here: -.. toctree:: - :maxdepth: 1 - - release/installation.introduction - release/userguide.introduction - release/release-notes +- :doc:`Installation Introduction` +- :doc:`User Guide and Configuration Guide` +- :doc:`Release Notes` Documentation for Anuket contributors ------------------------------------- -- cgit 1.2.3-korg