prepare montreal docs - config and release related files #1

Issue-ID: DOC-821

Change-Id: Ia56ac62cbd84aba9e06f00ce5c62d13b2ec2bbe6
Signed-off-by: thmsdt <thomas.kulik@telekom.de>

diff --git a/.gitreview b/.gitreview
index 43021f4..4e5826a 100644 (file)
--- a/.gitreview
+++ b/.gitreview
@@ -2,4 +2,4 @@
 host=gerrit.onap.org
 port=29418
 project=doc.git
-defaultbranch=master
+defaultbranch=montreal

diff --git a/docs/conf.py b/docs/conf.py
index 958179a..9911a14 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,6 +1,6 @@
 project = "onap"
-release = "master"
-version = "master"
+release = "montreal"
+version = "montreal"
 
 author = "Open Network Automation Platform"
 # yamllint disable-line rule:line-length
@@ -46,13 +46,13 @@ intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.for
 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-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'] = ('{}/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-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)
@@ -71,14 +71,54 @@ intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch,
 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-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-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 = 'montreal'
+
+#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)
+
+
 html_last_updated_fmt = '%d-%b-%y %H:%M'
 
 def setup(app):

diff --git a/docs/guides/onap-developer/apiref/index.rst b/docs/guides/onap-developer/apiref/index.rst
index bc3c184..937460b 100644 (file)
--- a/docs/guides/onap-developer/apiref/index.rst
+++ b/docs/guides/onap-developer/apiref/index.rst
@@ -21,7 +21,8 @@ User Interfaces
    :titlesonly:
 
 * :ref:`CLAMP - Closed Loop Automation Platform<onap-policy-parent:clamp-label>`
-* :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
+
+.. * :ref:`SDC - Service Design and Creation<onap-sdc:offeredapis>`
 
 Platform Components
 -------------------

diff --git a/docs/index.rst b/docs/index.rst
index 749e694..e7c4146 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,11 +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 'London' can be found**
-    `[here] <https://docs.onap.org/en/london/>`__
-
-
-|
+    **The official release documentation for ONAP 'Montreal' can be found**
+..    `[here] <https://docs.onap.org/en/montreal/>`__
 
 ..
 .. please disable above in the release version
@@ -44,8 +41,8 @@ any product could on its own.
 
 -------------------------------------------------------------------------------
 
-:ref:`'London' Release Notes <onap-release-notes>`
---------------------------------------------------
+:ref:`'Montreal' Release Notes <onap-release-notes>`
+----------------------------------------------------
 
 .. figure:: _static/file.svg
     :align: left

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 88c2e5b..0a2e0f7 100644 (file)
--- 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.
 
-London Releases
-===============
+Montreal Releases
+=================
 
 The following releases are available:
-  - `London Major Release 12.0.0`_
+  - `Montreal Major Release 13.0.0`_
 
-London Major Release 12.0.0
-===========================
+Montreal Major Release 13.0.0
+=============================
 
 +--------------------------------------+--------------------------------------+
 | **Project**                          | Documentation Project                |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release name**                     | London                               |
+| **Release name**                     | Montreal                             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release version**                  | 12.0.0                               |
+| **Release version**                  | 13.0.0                               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
@@ -37,14 +37,10 @@ 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.
-- The guide to set up a development system for documentation was updated.
-- Improved navigation structure.
-- Updated 'Guides' section.
+
+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.
 
 All JIRA tickets for this release can be found here:
 `ONAP Documentation Jira`_

diff --git a/docs/release/history.rst b/docs/release/history.rst
index a50444a..21f672e 100644 (file)
--- 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           |
 +=================+=================+========================+
+| Montreal        | 13.0.0          | not released yet       |
++-----------------+-----------------+------------------------+
 | London          | 12.0.0          | 2023, July 6th         |
 +-----------------+-----------------+------------------------+
 | Kohn            | 11.0.0          | 2022, December 1st     |

diff --git a/docs/release/index.rst b/docs/release/index.rst
index 5a1a85c..86da47c 100644 (file)
--- a/docs/release/index.rst
+++ b/docs/release/index.rst
@@ -5,10 +5,10 @@
 
 .. _onap-release-notes:
 
-'London' Release Notes
-======================
+'Montreal' Release Notes
+========================
 
-This page provides the release notes for the ONAP 'London' release. This
+This page provides the release notes for the ONAP 'Montreal' release. This
 includes details of software versions, known limitations, and outstanding
 trouble reports.
 
@@ -20,118 +20,53 @@ 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.
 
-'London' Major Release 12.0.0
------------------------------
+'Montreal' Major Release 13.0.0
+-------------------------------
 
 +-----------------------------------+-----------------------------------------+
 | **Project**                       | Open Network Automation Platform (ONAP) |
 +-----------------------------------+-----------------------------------------+
-| **Release name**                  | London                                  |
+| **Release name**                  | Montreal                                |
 +-----------------------------------+-----------------------------------------+
-| **Release version**               | 12.0.0                                  |
+| **Release version**               | 13.0.0                                  |
 +-----------------------------------+-----------------------------------------+
-| **Release date**                  | 2023, July 6th                          |
+| **Release date**                  | not released yet                        |
 +-----------------------------------+-----------------------------------------+
 
 Features
 --------
 
-ONAP 'London' focusses on:
-
-- ONAP takeaways to get feedback from consumers on what we need to prioritize 
-- ONAP evolution definition and mission statement refresh
-- Modularity and module bundles for specific use cases (O-RAN SMO, Network
-  slicing etc.)
-- Managing unmaintained projects
-- Formalizing ONAP as key player in open RAN @ O-RAN SC TOC Level
-- Getting first project: CPS road for gold badge  
-- SBOMs delivery 
-- Streamlining Release Management tasks
-- Implementing Service Mesh with ISTIO
-- Improving software quality by fixing bugs and upgrading components packages
-- First implementation of Java 17 
+ONAP 'Montreal' focusses on:
+
+- to be done
 
 Functional Requirements
 -----------------------
 
-Richer Set of Cloud Native Functionality
+tbd
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- Implements ASD-based CNF package onboarding and lifecycle orchestration.
-- Support 3GPP 28.582 APIs for slicing use case.
-
-E2E Network Slicing
-^^^^^^^^^^^^^^^^^^^
-
-Added support for 3GPP 28.532 based APIs in NSSMF for network slicing, with
-focus on RAN slicing.
-
-Control Loop Evolutions
-^^^^^^^^^^^^^^^^^^^^^^^
-
-- Improvements to CLAMP Automation Composition Management (ACM).
-- Metadata driven API Generation.
-- Improved Metrics and SLAs.
-- Improved Testing.
-
-Extended O-RAN Integration
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-- Enhancements for Configuration Management notification from O-RAN network
-  functions over O1 interface.
-
-Controllers
-^^^^^^^^^^^
-
-- A1 policy and platform enhancements from CCSDK.
-
-Service Design
-^^^^^^^^^^^^^^
-
-- Support for constraints.
-- UI support for view/edit/import data types.
-- Increased support for TOSCA functions.
-- Removed need for USER_ID cookie and header.
-
-Inventory
-^^^^^^^^^
-
-- Addition of Cell and Neighbour objects. 
-
-ONAP Operations Manager
-^^^^^^^^^^^^^^^^^^^^^^^
-
-- Introduction of "Production" ONAP setup.
-- Removal of unsupported components (AAF, Portal, Contrib,...).
-- Update of component helm charts to use common templates and practices.
-- Introduction of Kubernetes Operators for Cassandra (k8ssandra-operator) - to
-  support latest Cassandra version (optional for London) and Keycloak.
+- tbd
 
 Non-Functional Requirements
 ---------------------------
 
-The following 'non-functional' requirements are followed in the 'London'
-Release:
+The 'non-functional' requirements of this release are:
 
 Security
 ^^^^^^^^
 
-- SBOMs generation.
-- Packages upgrades to limit number of affecting vulnerabilities.
+- tbd
 
 Documentation
 ^^^^^^^^^^^^^
 
-- Interactive architecture diagram updated
-- End-2-End guides removed because they have become outdated due to
-  unmaintained projects.
+- tbd
 
 Tests & Integration
 ^^^^^^^^^^^^^^^^^^^
 
-- Minor bug fixes, package upgrades and python version fixes.
-- Migration out of Orange infra and pipelines was started.
-
+- tbd
 
 .. important::
    Some non-functional requirements are not fully finalized. Please, check
@@ -140,7 +75,7 @@ Tests & Integration
 Documentation Sources
 ---------------------
 
-The formal ONAP 'London' Release Documentation is available
+The formal ONAP 'Montreal' Release Documentation is available
 in :ref:`ReadTheDocs<master_index>`.
 
 The `Developer Wiki <http://wiki.onap.org>`_ remains a good source of
@@ -155,11 +90,11 @@ ONAP has adopted the `OpenSSF Best Practice Badge Program <https://bestpractices
 - `Badging Requirements <https://github.com/coreinfrastructure/best-practices-badge>`_
 - `Badging Status for all ONAP projects <https://bestpractices.coreinfrastructure.org/en/projects?q=onap>`_
 
-In the London release,
+In the Montreal release,
 
-- 100% projects passed 90% of the OpenSSF badge
-- 86% passed the OpenSSF badge
-- 11% projects passed the OpenSSF Silver badge
+- x% projects passed 90% of the OpenSSF badge
+- x% passed the OpenSSF badge
+- x% projects passed the OpenSSF Silver badge
 
 Project specific details are in the :ref:`release notes<component-release-notes>`
 for each component.
@@ -168,7 +103,7 @@ for each component.
 
 ONAP Maturity Testing Notes
 ---------------------------
-For the 'London' release, ONAP continues to improve in multiple areas of
+For the 'Montreal' 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>`

diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt
index 5616848..6faa4de 100644 (file)
--- a/docs/requirements-docs.txt
+++ b/docs/requirements-docs.txt
@@ -8,3 +8,4 @@ sphinxcontrib-plantuml
 sphinx_toolbox
 autopep8
 pylint
+graphviz