diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2022-08-11 13:05:18 +0200 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2022-08-15 11:29:05 +0200 |
| commit | 65bec69096b0a2ef18cd72d87b89757da4ae1906 (patch) | |
| tree | 476e24f31652b96e4c4882a604dc45337e814bb7 /docs/index.rst | |
| parent | cb58877ab3d3e54d6ad22dc348064e75bf0957a1 (diff) | |
improve navigation and readability
Issue-ID: DOC-798
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 45 |
1 files changed, 37 insertions, 8 deletions
diff --git a/docs/index.rst b/docs/index.rst index e0bd37d89..93985b664 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,13 +21,15 @@ any product could on its own. Please find some guidance here on the content of ONAP documentation: +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Main documentation areas | Description | + | Documentation areas | Description | +=================================================================================+===============================================================================================+ | :ref:`ONAP 'Jakarta' Release Notes <onap-release-notes>` | The Release Notes are providing general information about the ONAP release and recent changes,| | | feature enhancements, or bug fixes. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Project Specific Release Notes <doc-releaserepos>` | The Project Specific Release Notes are providing information about recent changes, feature | - | | enhancements, or bug fixes on a component level. | + | :ref:`Component Release Notes <component-release-notes>` | The Component Release Notes are providing project specific information about recent changes, | + | | features, enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Release History <release-history>` | The list contains the name and date of previous ONAP releases. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview <overview>` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | @@ -53,7 +55,7 @@ Please find some guidance here on the content of ONAP documentation: | | ONAP Documentation Guide. Currently some content resides also in the Developer Guide. This is | | | subject to be reviewed, updated and migrated to the ONAP Documentation Guide. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Security <onap-security>` | The current state of ONAP Security is described here. You can learn about discovered and fixed| + | :ref:`ONAP Security <onap-security-index>` | The current state of ONAP Security is described here. You can learn about discovered and fixed| | | vulnerabilities. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -63,12 +65,39 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home <self> + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: RELEASE + release/index - release/releaserepos - guides/overview/index - guides/onap-developer/architecture/index - guides/onap-developer/developing/index + release/component-release-notes + release/history + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: PLATFORM + + platform/overview/index + platform/architecture/index + platform/components/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: GUIDES + guides/onap-operator/index guides/onap-user/index guides/onap-developer/index guides/onap-documentation/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: SECURITY + + security/index +
\ No newline at end of file |