X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Findex.rst;h=e7c4146c1fe40a016f025a4a1261cabab929e8a4;hb=56d2c36d46706063c8eb30b7b0b55ceb60c0f49a;hp=e65a7864c3c1a5a8cc931f0b3d817ff054652d44;hpb=5c0bf982cf90bd0a7267a4fccbd941bddba52301;p=doc.git diff --git a/docs/index.rst b/docs/index.rst index e65a7864c..e7c4146c1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,9 +1,29 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. - .. _master_index: + + +.. please disable below in the release version +.. +.. warning:: **WORK IN PROGRESS** + + .. figure:: _static/exclamation-triangle.svg + :align: left + :scale: 760% + :figwidth: 120px + + This is a development version of ONAP documentation. It continually + develops as the contributing projects develop. Even if you read a specific + release name here, the content may cover a future ONAP release. + + **The official release documentation for ONAP 'Montreal' can be found** +.. `[here] `__ + +.. +.. please disable above in the release version + Open Network Automation Platform ================================ @@ -19,48 +39,156 @@ the acceleration of the development of a vibrant ecosystem around a globally shared architecture and the implementation of network automation faster than any product could on its own. -Please find some guidance here on the content of ONAP documentation: - - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | Main 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 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 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:`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:`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:`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 Documenation Guide. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ - | :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:`ONAP Security ` | The current state of ONAP Security is described here. We can learn about discovered and fixed | - | | vulnerabilities. | - +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ +------------------------------------------------------------------------------- + +:ref:`'Montreal' Release Notes ` +---------------------------------------------------- + +.. figure:: _static/file.svg + :align: left + :scale: 300% + :figwidth: 50px + +General information about the new ONAP release and recent changes, feature +enhancements, or bug fixes. + +| + +:ref:`Component Release Notes ` +-------------------------------------------------------- + +.. figure:: _static/files.svg + :align: left + :scale: 300% + :figwidth: 50px + +Project specific information about recent changes, features, enhancements, or +bug fixes. + +| + +:ref:`Release History ` +---------------------------------------- + +.. figure:: _static/clock-history.svg + :align: left + :scale: 300% + :figwidth: 50px + +Names and release dates of previous ONAP versions. + +| + +------------------------------------------------------------------------------- + +:ref:`Use Cases, Blueprints, Requirements ` +----------------------------------------------------------- + +.. figure:: _static/bullseye.svg + :align: left + :scale: 300% + :figwidth: 50px + +ONAP covers a wide range of use cases for Communication Service Providers (CSP) +and the open source networking industry. Read about the latest verified use +cases, functional requirements and blueprints to achieve your goals. + +| + +------------------------------------------------------------------------------- + +:ref:`Overview ` +-------------------------- + +.. figure:: _static/eye.svg + :align: left + :scale: 300% + :figwidth: 50px + +A 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:`Architecture ` +--------------------------------------- + +.. figure:: _static/columns-gap.svg + :align: left + :scale: 300% + :figwidth: 50px + +A general description of functional ONAP components and how they interact. +Covers the design-time and runtime framework, ONAP microservices and common +services. + +| + +:ref:`Components and Functionalities ` +------------------------------------------------------------------------- + +.. figure:: _static/diagram-3.svg + :align: left + :scale: 300% + :figwidth: 50px + +A individual description of every ONAP component and its features. + +| + +------------------------------------------------------------------------------- + +:ref:`Operations and Administration Guides ` +-------------------------------------------------------------- + +.. figure:: _static/person-gear.svg + :align: left + :scale: 300% + :figwidth: 50px + +The installation of ONAP, its management, monitoring and other operational +tasks like integration or user management are covered here. + +| + +:ref:`Developer Guides ` +----------------------------------------------- + +.. figure:: _static/code-slash.svg + :align: left + :scale: 300% + :figwidth: 50px + +Developers contributing to the ONAP development can find information here. + +| + +:ref:`Documentation Guides ` +------------------------------------------------------- + +.. figure:: _static/filetype-rst.svg + :align: left + :scale: 300% + :figwidth: 50px + +A guide to set up a documentation development environment, documentation style +guides, tips and templates are provided here. + +| + +------------------------------------------------------------------------------- + +:ref:`Vulnerabilities and Advisories ` +----------------------------------------------------------- + +.. figure:: _static/shield.svg + :align: left + :scale: 300% + :figwidth: 50px + +Describes the current state of ONAP Security. Learn about discovered and fixed +vulnerabilities and how to report them. .. toctree:: @@ -68,12 +196,44 @@ 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: USE CASES + + usecases/index + +.. 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 - guides/onap-provider/index + +.. toctree:: + :maxdepth: 1 + :hidden: + :caption: SECURITY + + security/index