Please find some guidance here on the content of ONAP documentation:
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Main documentation areas | Description |
+ | Documentation areas | Description |
+=================================================================================+===============================================================================================+
- | :ref:`Release Notes <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 'Kohn' 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:`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 |
| | security references support understanding the solution. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | :ref:`ONAP Architecture <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 <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 <doc_onap-developer_guide_projects>` | 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 <doc_onap-developer_guide_projects>` | 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 <operation_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 <operation_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 <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 <ONAP_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 <ONAP_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:`Documentation Guides <ONAP_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:`VNF/PNF Requirements and Guidelines <vnf_pnf_reqs>` | 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:`ONAP Security <onap-security-index>` | The current state of ONAP Security is described here. You can learn about discovered and fixed|
+ | | vulnerabilities. |
+---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+
:hidden:
Home <self>
+
+.. 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
Code Review / doc.git / blobdiff