diff options
| author |   thmsdt <thomas.kulik@telekom.de> | 2021-05-10 07:54:33 -0700 |
|---|---|---|
| committer | thmsdt <thomas.kulik@telekom.de> | 2021-05-19 06:14:48 -0700 |
| commit | 1b4888377d2086c2468a427a853c477bf8ccdab1 (patch) | |
| tree | 62a743c9a46bf57cb0a36c1145cdb838e72bf725 /docs/index.rst | |
| parent | cc09ff06fb78a52747ec8c6752ac2c9308553b8a (diff) | |
Add guide for a doc dev system
Issue-ID: DOC-742
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ie6071576bce613edaf50433b7b84b69b16e0e88c
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 619af5f73..e65a7864c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,12 +31,12 @@ Please find some guidance here on the content of ONAP documentation: | | 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 | + | :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 components and functionalities <doc_onap-developer_guide_projects>` | The ONAP components and functionalities are described in details here. | + | :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. | +---------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------------+ @@ -50,6 +50,10 @@ Please find some guidance here on the content of ONAP documentation: | | in the Developer Guides. The reader 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 Documenation 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. | @@ -71,4 +75,5 @@ Please find some guidance here on the content of ONAP documentation: guides/onap-operator/index guides/onap-user/index guides/onap-developer/index + guides/onap-documentation/index guides/onap-provider/index |