diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 45 | ||||
| -rw-r--r-- | docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/release-notes.rst | 17 | ||||
| -rw-r--r-- | docs/release/history.rst | 2 | ||||
| -rw-r--r-- | docs/release/index.rst | 22 |
6 files changed, 68 insertions, 28 deletions
diff --git a/docs/conf.py b/docs/conf.py index 958179ae9..f36ed25b5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -36,6 +36,50 @@ extensions = [ # Change to {releasename} after you have created the new 'doc' branch. # +branch = 'newdelhi' + +intersphinx_mapping = {} +doc_url = 'https://docs.onap.org/projects' +master_doc = 'index' + +#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-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-ccsdk-oran'] = ('{}/onap-ccsdk-oran/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-cli'] = ('{}/onap-cli/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-cps'] = ('{}/onap-cps/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-cps-cps-temporal'] = ('{}/onap-cps-cps-temporal/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-cps-ncmp-dmi-plugin'] = ('{}/onap-cps-ncmp-dmi-plugin/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-dcaegen2'] = ('{}/onap-dcaegen2/en/%s'.format(doc_url) % branch, None) +#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-messagerouter-messageservice'] = ('{}/onap-dmaap-messagerouter-messageservice/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'] = ('{}/onap-holmes-rule-management/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-oom'] = ('{}/onap-oom/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-optf-osdf'] = ('{}/onap-optf-osdf/en/%s'.format(doc_url) % branch, None) +#intersphinx_mapping['onap-osa'] = ('{}/onap-osa/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-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) + + branch = 'latest' intersphinx_mapping = {} @@ -79,6 +123,7 @@ intersphinx_mapping['onap-usecase-ui'] = ('{}/onap-usecase-ui/en/%s'.format(doc_ intersphinx_mapping['onap-vfc-nfvo-lcm'] = ('{}/onap-vfc-nfvo-lcm/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) + html_last_updated_fmt = '%d-%b-%y %H:%M' def setup(app): diff --git a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst index c08427bf5..62db6abec 100644 --- a/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst +++ b/docs/guides/onap-documentation/setup-of-a-doc-dev-system.rst @@ -789,10 +789,6 @@ Sphinx - `Sphinx Documentation Generator <https://www.sphinx-doc.org/en/master/>`__ -Ubuntu ------- - -- `Virtualized Ubuntu Desktop Edition <https://linuxconfig.org/ubuntu-20-04-system-requirements>`__ Visual Studio Code (VSC) ------------------------ diff --git a/docs/index.rst b/docs/index.rst index caa01b63b..ac48bf81f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,8 +18,8 @@ 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] <https://docs.onap.org/en/montreal/>`__ + .. **The official release documentation for ONAP 'NewDelhi' can be found** + .. `[here] <https://docs.onap.org/en/newdelhi/>`__ | @@ -44,7 +44,7 @@ any product could on its own. ------------------------------------------------------------------------------- -:ref:`'Montreal' Release Notes <onap-release-notes>` +:ref:`'NewDelhi' Release Notes <onap-release-notes>` ---------------------------------------------------- .. figure:: _static/file.svg diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ea40a5d49..ffded0f38 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -12,23 +12,23 @@ Release Notes This document provides the release notes for the documentation project. -Montreal Releases +NewDelhi Releases ================= The following releases are available: - - `Montreal Major Release 13.0.0`_ + - `NewDelhi Major Release 14.0.0`_ -Montreal Major Release 13.0.0 +NewDelhi Major Release 14.0.0 ============================= +--------------------------------------+--------------------------------------+ | **Project** | Documentation Project | | | | +--------------------------------------+--------------------------------------+ -| **Release name** | Montreal | +| **Release name** | NewDelhi | | | | +--------------------------------------+--------------------------------------+ -| **Release version** | 13.0.0 | +| **Release version** | 14.0.0 | | | | +--------------------------------------+--------------------------------------+ @@ -37,14 +37,11 @@ New features ------------ - Documentation cleaned up. -- Projects (repositories) which do not create a stable release branch are no - longer included in the release documentation. This should help to improve the - release management process. - Example configuration files for setting up a proper process of documentation - creation were updated. Please check the 'doc' repository. + creation were updated. Please check the 'doc-best-practice' repository. - Updated 'Guides' section. All JIRA tickets for this release can be found here: `ONAP Documentation Jira`_ -.. _`ONAP Documentation Jira`: https://jira.onap.org/issues/?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22Montreal%20Release%22%20%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC +.. _`ONAP Documentation Jira`: https://jira.onap.org/issues/?jql=project%20%3D%20DOC%20AND%20fixVersion%20%3D%20%22NewDelhi%20Release%22%20%20ORDER%20BY%20priority%20DESC%2C%20updated%20DESC diff --git a/docs/release/history.rst b/docs/release/history.rst index 37f6e75f6..8815b601e 100644 --- a/docs/release/history.rst +++ b/docs/release/history.rst @@ -13,6 +13,8 @@ is named after a city. +-----------------+-----------------+------------------------+ | Release Name | Release Version | Release Date | +=================+=================+========================+ +| NewDelhi | 14.0.0 | 2024, not released yet | ++-----------------+-----------------+------------------------+ | Montreal | 13.0.0 | 2023, December 14th | +-----------------+-----------------+------------------------+ | London | 12.0.0 | 2023, July 6th | diff --git a/docs/release/index.rst b/docs/release/index.rst index 6b7cae07e..555ca8b7b 100644 --- a/docs/release/index.rst +++ b/docs/release/index.rst @@ -5,10 +5,10 @@ .. _onap-release-notes: -'Montreal' Release Notes +'NewDelhi' Release Notes ======================== -This page provides the release notes for the ONAP 'Montreal' release. This +This page provides the release notes for the ONAP 'NewDelhi' release. This includes details of software versions, known limitations, and outstanding trouble reports. @@ -20,21 +20,21 @@ release notes and links to those release notes are provided below. Details on the specific items delivered in each release by each component is maintained in the component specific release notes. -'Montreal' Major Release 13.0.0 +'NewDelhi' Major Release 14.0.0 ------------------------------- +-----------------------------------+-----------------------------------------+ | **Project** | Open Network Automation Platform (ONAP) | +-----------------------------------+-----------------------------------------+ -| **Release name** | Montreal | +| **Release name** | NewDelhi | +-----------------------------------+-----------------------------------------+ -| **Release version** | 13.0.0 | +| **Release version** | 14.0.0 | +-----------------------------------+-----------------------------------------+ -| **Release date** | 2023, December 14th | +| **Release date** | 2024, not released yet | +-----------------------------------+-----------------------------------------+ ONAP is evolving. We took efforts in streamlining processes and roles and -Montreal release is the first one with agreed simplified software development +NewDelhi release is the first one with agreed simplified software development life cycle governance. OpenSSF Gold Standard @@ -93,7 +93,7 @@ ONAP user to make use of latest OpenDaylight software when they use latest release of ONAP. PortalNG --------- +--------s We introduced new PortalNG as a maintained alternative to the unmaintained Portal project. Allows ONAP user to make informed decisions on software use of @@ -102,7 +102,7 @@ maintained and unmaintained projects. Documentation Sources --------------------- -The formal ONAP 'Montreal' Release Documentation is available +The formal ONAP 'NewDelhi' Release Documentation is available in :ref:`ReadTheDocs<master_index>`. The `Developer Wiki <http://wiki.onap.org>`_ remains a good source of @@ -118,7 +118,7 @@ ONAP has adopted the `OpenSSF Best Practice Badge Program <https://bestpractices - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_ -In the Montreal release, +In the NewDelhi release, - 100% projects passed 95% of the OpenSSF badge - 94% passed the OpenSSF badge @@ -132,7 +132,7 @@ for each component. ONAP Maturity Testing Notes --------------------------- -For the 'Montreal' release, ONAP continues to improve in multiple areas of +For the 'NewDelhi' release, ONAP continues to improve in multiple areas of Scalability, Security, Stability and Performance (S3P) metrics. More details in :ref:`ONAP Integration Project<onap-integration:master_index>` |