diff options
author | Andreas Geissler <andreas-geissler@telekom.de> | 2021-10-19 11:10:28 +0000 |
---|---|---|
committer | thmsdt <thomas.kulik@telekom.de> | 2021-10-19 14:42:07 +0200 |
commit | fc99e1bc50f2b9a3c9597a23adfd77cbe0013e8c (patch) | |
tree | 9268b39613cac7f2bea09628fab0089fc8bb81da | |
parent | f588ecc3d9da4be9d0aa3c94f151759256fcadfe (diff) |
Update the conf.py and ONAP component, release, architectur, api
Issue-ID: DOC-771
Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de>
Change-Id: I914805302832f9adf59a13174284365c9424066f
-rw-r--r-- | docs/conf.py | 36 | ||||
-rw-r--r-- | docs/guides/onap-developer/apiref/index.rst | 1 | ||||
-rw-r--r-- | docs/guides/onap-developer/architecture/references.rst | 1 | ||||
-rw-r--r-- | docs/guides/onap-developer/developing/index.rst | 14 | ||||
-rw-r--r-- | docs/release/releaserepos.rst | 1 |
5 files changed, 33 insertions, 20 deletions
diff --git a/docs/conf.py b/docs/conf.py index 81f5e2442..01509ca16 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,20 @@ from docs_conf.conf import * +# Change the line below from 'latest' to '<Name_of_the_new_ONAP_Release>' after +# you have create the new branch for the 'doc' project. branch = 'latest' doc_url = 'https://docs.onap.org/projects' master_doc = 'index' intersphinx_mapping = {} -# Latest (change to branch) +# +# Mapping to 'latest' if this files is used in 'latest' (master) branch. +# Changed to '<Name_of_the_new_ONAP_Release>' after you have create the new +# branch for the 'doc' project. +# + +# Latest | <Name_of_the_new_ONAP_Release> intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) @@ -23,7 +31,6 @@ intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ( intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-holmes-engine-management'] = ( '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-holmes-rule-management'] = ( @@ -37,17 +44,16 @@ intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom-platform-cert-service'] = ( '{}/onap-oom-platform-cert-service/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-optf-cmso'] = ('{}/onap-optf-cmso/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-optf-has'] = ('{}/onap-optf-has/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-policy-clamp'] = ('{}/onap-policy-clamp/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-policy-parent'] = ('{}/onap-policy-parent/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdc'] = ('{}/onap-sdc/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-sdnc-oam'] = ('{}/onap-sdnc-oam/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-so'] = ('{}/onap-so/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) @@ -55,6 +61,17 @@ intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s' intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) +# +# Mapping to an older version of documentation for those projects who are part +# of the new ONAP release but have not created a branch for it. +# This can happen e.g. for 'unmaintained' (but still required) projects. +# + +# Honolulu +branch = 'honolulu' +intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) + # Guilin branch = 'guilin' intersphinx_mapping['onap-portal'] = ('{}/onap-portal/en/%s'.format(doc_url) % branch, None) @@ -65,13 +82,18 @@ intersphinx_mapping['onap-appc'] = ('{}/onap-appc/en/%s'.format(doc_url) % branc intersphinx_mapping['onap-appc-deployment'] = ('{}/onap-appc-deployment/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-music'] = ('{}/onap-music/en/%s'.format(doc_url) % branch, None) +# +# Mapping to 'latest' (master) version of documentation for those projects who +# are part of the new ONAP release but never have created a branch. +# + # Latest branch = 'latest' intersphinx_mapping['onap-aaf-authz'] = ('{}/onap-aaf-authz/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-platform-plugins'] = ( diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst index 5b5a95c5c..f78f1107e 100644 --- a/docs/guides/onap-developer/apiref/index.rst +++ b/docs/guides/onap-developer/apiref/index.rst @@ -50,7 +50,6 @@ Common Services * :ref:`AAF - Application Authorization Framework<onap-aaf-sms:offeredapis>` * :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:offeredapis>` -* :ref:`AAI ESR - AAI External System Register<onap-aai-esr-server:offeredapis>` * :ref:`CPS - Configuration Persistence Service<onap-cps:design>` * :ref:`DMAAP DBC - Data Management as a Platform (Data Bus Controller)<onap-dmaap-dbcapi:offeredapis>` * :ref:`DMAAP DR - Data Management as a Platform (Data Router)<onap-dmaap-datarouter:master_index>` diff --git a/docs/guides/onap-developer/architecture/references.rst b/docs/guides/onap-developer/architecture/references.rst index b8ba83a78..6f6158447 100644 --- a/docs/guides/onap-developer/architecture/references.rst +++ b/docs/guides/onap-developer/architecture/references.rst @@ -61,7 +61,6 @@ Common Services | :ref:`AAF - Application Authorization Framework<onap-aaf-authz:master_index>` | :ref:`AAI - Active and Available Inventory<onap-aai-aai-common:architecture>` -| :ref:`AAI ESR<onap-aai-esr-gui:architecture>` | :ref:`CPS - Configuration Persistence Service<onap-cps:architecture>` | :ref:`DMAAP MR - Data Management as a Platform (Message Router)<onap-dmaap-messagerouter-messageservice:architecture>` | :ref:`ExtAPI - External API NBI<onap-externalapi-nbi:architecture>` diff --git a/docs/guides/onap-developer/developing/index.rst b/docs/guides/onap-developer/developing/index.rst index 082300cc9..0f1e590e3 100644 --- a/docs/guides/onap-developer/developing/index.rst +++ b/docs/guides/onap-developer/developing/index.rst @@ -62,10 +62,6 @@ AAI - Active and Available Inventory - Description * - :ref:`AAI<onap-aai-aai-common:master_index>` - AAI Architecture, APIs and Guides - * - :ref:`ESR GUI (Latest)<onap-aai-esr-gui:master_index>` - - (unmaintained) External System Registry GUI Documentation - * - :ref:`ESR Server (Latest)<onap-aai-esr-server:master_index>` - - (unmaintained) External System Registry Server Documentation * - :ref:`AAI UI<onap-aai-sparky-be:master_index>` - Sparky - AAI Inventory UI Documentation @@ -172,8 +168,8 @@ EXTAPI - External API Framework/NBI * - Document - Description - * - :ref:`EXTAPI<onap-externalapi-nbi:master_index>` - - External API Framework Documentation + * - :ref:`EXTAPI (Honolulu)<onap-externalapi-nbi:master_index>` + - (unmaintained) External API Framework Documentation HOLMES - Holmes Alarm Correlation and Analysis ---------------------------------------------- @@ -252,8 +248,6 @@ OOF - Optimization Framework - ONAP policy-driven placement optimizing service documentation * - :ref:`Optimization Service Design Framework<onap-optf-osdf:master_index>` - Optimization Service Design Framework documentation - * - :ref:`Change Management Schedule Optimization<onap-optf-cmso:master_index>` - - Change Management Schedule Optimization documentation OOM - ONAP Operations Manager ----------------------------- @@ -389,8 +383,8 @@ VID - Virtual Infrastructure Deployment * - Document - Description - * - :ref:`VID<onap-vid:master_index>` - - Virtual Infrastructure Deployment Architecture, APIs and Guides + * - :ref:`VID (Honolulu)<onap-vid:master_index>` + - (unmaintained) Virtual Infrastructure Deployment Architecture, APIs and Guides VNFSDK - VNF Software Development Kit ------------------------------------- diff --git a/docs/release/releaserepos.rst b/docs/release/releaserepos.rst index a376590fd..f3b07fa7d 100644 --- a/docs/release/releaserepos.rst +++ b/docs/release/releaserepos.rst @@ -60,7 +60,6 @@ Unmaintained Projects :maxdepth: 1 | :ref:`AAF - Application Authorization Framework<onap-aaf-authz:release_notes>` -| :ref:`AAI/ESR - External System Registry<onap-aai-esr-server:master_index>` | :ref:`APPC - Application Controller<onap-appc:release_notes>` | :ref:`EXTAPI - External API NorthBound Interface<onap-externalapi-nbi:release_notes>` | :ref:`MUSIC - ONAP Multi-Site Integration<onap-music:release_notes>` |