X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=93985b664913c8abe11b016055f0266b992c21f2;hb=db486fc190b9e2817598ff0ec5cafc3ce1bf7732;hp=64ff88783085312381447c53f7d0a538fef0aba4;hpb=8d51f37a1a93c1b649e8c2c74b55500a9a95529a;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index 64ff88783..93985b664 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,39 +21,43 @@ 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:`Release Notes ` | The Release Notes besides providing the basic information on the main release, also | - | | presents link to the release information of each, specific ONAP component. | + | :ref:`ONAP 'Jakarta' Release Notes ` | The Release Notes are providing general information about the ONAP release and recent changes,| + | | feature enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`Component Release Notes ` | The Component Release Notes are providing project specific information about recent changes, | + | | features, enhancements, or bug fixes. | + +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ + | :ref:`ONAP Release History ` | The list contains the name and date of previous ONAP releases. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`ONAP Overview ` | ONAP Overview provides generic and high-level guidance on the mission and main | | | functionalities of ONAP. Basic guidelines on license details, limitations and | | | security references support understanding the solution. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP Architecture ` | The ONAP architecture and its functional elements are described in details | - | | here. We can learn how the two main frameworks, namely the Design-time | - | | framework and the Run-time framework cooperate and how the Microservices, | - | | Common services and the ONAP Portal support the certain functions. | + | :ref:`ONAP Architecture ` | The ONAP Architecture and its functional elements are described in details here. You can learn| + | | how the two main frameworks, namely the Design-time framework and the Run-time framework | + | | cooperate and how the Microservices and Common services support certain functions. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`ONAP components and functionalities ` | The ONAP components and functionalities are described in details here. | - | | We can learn what functionalities ONAP provides and how the certain components in ONAP | - | | operate together. | + | :ref:`ONAP Components and Functionalities ` | The ONAP Components and Functionalities are described in details here. You can learn what | + | | functionalities ONAP provides and how the certain components in ONAP operate together. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Operations and Adminstration Guides ` | ONAP Platform operation and adminstration cover the configuration and installation of ONAP, | - | | its management, monitoring and other operational tasks (integration, user management,...) | + | :ref:`Operations and Adminstration Guides ` | ONAP Platform Operations and Adminstration covers the configuration and installation of ONAP, | + | | its management, monitoring and other operational tasks (integration, user management, ...) | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ | :ref:`User Guides ` | The User Guides focus on tasks to administer Services using ONAP, covering Service Design, | | | instantiation and their management using control loops | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`Developer Guides ` | Developers contributing to the ONAP development can find crucial information | - | | in the Developer Guides. The reader can search among the developers’ topics | - | | in alphabetical order. | + | :ref:`Developer Guides ` | Developers contributing to the ONAP development can find crucial information in the Developer | + | | Guides. You can search among the developers’ topics in alphabetical order. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :ref:`VNF/PNF Requirements and Guidelines ` | Harmonized VNF and PNF requirements and reduced customization of onboarding VNFs | - | | and PNFs can accelerate the optimal usage of this ONAP environment. The guidelines | - | | on VNF/PNF requirements facilitates synchronized and aligned activities for all participants. | + | :ref:`Documentation Guides ` | People interested in the creation of ONAP documentation can find crucial information in the | + | | 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 ` | The current state of ONAP Security is described here. You can learn about discovered and fixed| + | | vulnerabilities. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - .. toctree:: @@ -61,11 +65,39 @@ Please find some guidance here on the content of ONAP documentation: :hidden: Home + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: RELEASE + release/index - 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-provider/index + guides/onap-documentation/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: SECURITY + + security/index + \ No newline at end of file