Thomas Kulik

Create the new branch of the 'doc' project using gerrit

BRANCH: source/initial=master, target/new='newbranch'

FILE: n/a

DESCR: Please follow the instructions below.

1. Open https://gerrit.onap.org/r/admin/repos/doc,branches
2. Use [CREATE NEW] function on the top right corner
3. Set 'Branch name' to the name of the upcoming release (e.g. 'istanbul')
4. Set 'Initial revision' to 'master'
5. Use [CREATE] to create the new branch

Note: You are not allowed to delete a branch. If you need to (maybe due to a typo in the process of creation) you have to raise a ticket at the LF IT Support.

IMPORTANT: To trigger the documentation build in ReadTheDocs, you must change at least one of the ReStructuredText files (.rst) in the new branch. Only branching the repository does not trigger the RTD doc build process. Consequently the 'newbranch' version of documentation is missing in RTD.

OPEN: Currently we are branching 'doc' early - and consequently have to cherry-pick the changes (done in 'master') for 'newbranch'. Check if it is ok to branch later (after changing the majority of files). So we can reduce cherry-pick efforts.

Update 'doc' project release notes

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/release-notes.rst

DESCR: The file contains a description of the latest changes in the 'doc' project. Update it accordingly for the new release and cherry-pick the change for 'newbranch'.

EXAMPLE: 'release-notes.rst' for 'master' branch

› View in RTD

OPEN: check all project specific release notes (updated? release number/release name correct? ...)

OPEN: Evaluate if we can/should have only 'placeholder' files in the 'master' branch. This may avoid confusion in case people are looking to 'master' and seeing release specific content (e.g. related to 'istanbul'). Or should we remove - at least - release names in the RTD navigation (column on the left)?

Update 'marketing' ('composite') release note

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/release/index.rst

DESCR: This file contains a ('marketing') overview about the advantages and latest developments related to the new release. It is also known as the 'composite' release note. The text is authored by LFN marketing together with the ONAP TSC chair. They are using information from the 'Release Key Updates' table which is maintained by the projects during the release process (e.g. 'Release Key Updates' for the 'istanbul' release). The text is provided in text form and has to be converted to reStructuredText format manually. Update the file accordingly - especially the release date and cherry-pick the change for 'newbranch'.

CONTACT: Catherine Lefevre Kenny Paul Eric Debeau Brandon Wick

EXAMPLE: 'index.rst' for 'master' branch

› View in RTD

OPEN: Add a task/milestone for 'Marketing' to the release process?

OPEN: Describe the process of conversion to reStructuredText format. Example Source

Update list of project specific release notes

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/release/releaserepos.rst

DESCR: This file contains a table of contents (TOC) for project specific release notes. There are several sections to represent the current maintenance state of every project. Whenever a project/repository is deployed via OOM (standard ONAP installation), its release note must be part of the list - regardless if this project/repository is currently maintained, unmaintained or in another state. Update the file accordingly for the new release and cherry-pick the change for 'newbranch'.

EXAMPLE: 'releaserepos.rst' for 'master' branch

› View in RTD

OPEN: Add reliable source for 'release participating projects/repositories' and their 'maintenance-state' and - in addition - those ('unmaintained') projects which are deployed 'on top' by OOM team (because the projects/repos are still required for a good reason).

OPEN: There are plans for upcoming releases to include only projects/repositories which are in 'maintained' state and have created a branch for the new release.

Update release history in overview

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/guides/overview/overview.rst

DESCR: This file contains a table with the release history (release number, date, name). Update the file accordingly for the new release and cherry-pick the change for 'newbranch'.

EXAMPLE: 'overview.rst' for 'master' branch

› View in RTD

OPEN: Additional check and update by Architecture Subcommittee required?

Update architecture description

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/guides/onap-developer/architecture/onap-architecture.rst

DESCR: This file contains a description of the ONAP architecture. Update the file accordingly for the new release and cherry-pick the change for 'newbranch'.

EXAMPLE: 'onap-architecture.rst' for 'master' branch

› View in RTD

OPEN: Activity for the Architecture Subcommittee (change rst file and propose a patch)? Add task/milestone to the release process? To be aligned with marketing department?

Update references in 'ONAP Components and Functionalities' section

BRANCH: master; then cherry-pick for 'newbranch'

FILE: doc/docs/guides/onap-developer/developing/index.rst

DESCR: This file contains references to the detailed documentation of ONAP projects, components and functionalities. Update the file accordingly for the new release and cherry-pick the change for 'newbranch'.

EXAMPLE: 'index.rst' for 'master' branch

› View in RTD

OPEN: There are plans for upcoming releases to include only projects/repositories which are in 'maintained' state and have created a branch for the new release.

Update sphinx build configuration file 'conf.py' ('master')

BRANCH: 'master'

FILE: doc/docs/conf.py

DESCR: The Sphinx build configuration file 'conf.py' contains configuration needed to customize Sphinx input and output behavior. Please follow the instructions below.

1. Set 'intersphinx_mapping' for all participating projects/repositories.
2. Remove 'intersphinx_mapping' for projects/repositories not participating.

Note: The different 'intersphinx_mapping' sections in the 'conf.py' represent the different state of development in the ONAP projects and their repositories. We have to differentiate between:

• Projects/repos that have created a branch for the upcoming release. That's why the entries are mapping to project documentation in the new created branch (branch = 'newbranch').
• Projects/repos that have not created a branch for the upcoming release, but for a previous release. That's why the entries are mapping to project documentation in a previous branch (e.g. branch = 'frankfurt' or branch = 'guillin').
• Projects/repos that have never created a branch. That's why the entries are mapping to project documentation in the 'master' branch of ONAP (branch = 'latest'). The ONAP 'master' branch is mapped to 'latest' in ReadTheDocs.

EXAMPLE: 'conf.py' for 'master' branch

OPEN: Add reliable source for the info if a project has/hasn't branched.

OPEN: Include changes/actions required because we have introduced constraints-files.

OPEN: Update to 'conf.yaml' required after branching the repo?

OPEN: There are plans for upcoming releases to include only projects/repositories which are in 'maintained' state and have created a branch for the new release.

Update interactive ONAP architecture overview and related files ('master')

BRANCH: 'master'

FILE #1: doc/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg

FILE #2: doc/docs/guides/onap-developer/architecture/onap-architecture.rst

CONTACT: Thomas Kulik

DESCR: Please follow the instructions below.

1. Optional: Open the file 'onap-architecture-overview-labels-and-links.xlsx', check if links are reachable (to be detailed)
2. The interactive ONAP architecture overview (svg format, maintained by the 'doc' project team) needs to be aligned with the official ONAP architecture diagram maintained by the Architecture Subcommittee (e.g. Istanbul-R9 Architecture Diagram). Open the file 'onap-architecture-overview-interactive.svg' in Inkscape and change the architecture building blocks accordingly.
3. In the 'Objects' window find the 'releaseinfo.link' object. Make it visible by clicking on the 'closed eye' symbol to change it to an 'open eye' symbol. Now the release info should be visible on the overview.
4. Click on tab 'Object attributes' and check/update the content of the field 'Href:' (the link must point to 'latest').
5. Update the content of the field 'Title:' to show the new release number and name (e.g. 'ONAP Release 9 »Istanbul«').
6. In the 'Objects' window find the 'releaseinfo.link' object. Make it invisible again by clicking on the 'open eye' symbol to change it to a 'closed eye' symbol. Now the release info should be no longer visible on the overview.
7. Save the file.
8. Save the file a second time, but with a new filename. Use 'onap-architecture-overview-interactive-path.svg'.
9. Then select all  elements in the map and use the Inkscape function 'Path → Object to Path' to convert all elements to pathes. Read more about this in the onap-architecture-overview-notes.txt . Save the overview map, close Inkscape (and remember to do no  further changes to this 'pathed' version of the overview).
10. Info: In 'doc/docs/guides/onap-developer/architecture/onap-architecture.rst' you find a '.. raw:: html' section which contains the filename of the interactive ONAP architecture overview. You must use the filename of the 'pathed' version ('onap-architecture-overview-interactive-path.svg') here!

EXAMPLE: 'onap-architecture.rst' for 'master' branch

› View in RTD

OPEN: Describe how to update and test links in xls and svg.

Set correct 'defaultbranch' in '.gitreview'

BRANCH: 'newbranch'

FILE: doc/.gitreview

DESCR: Add/update the 'defaultbranch' entry accordingly (e.g. 'defaultbranch=honolulu' for the 'honolulu' branch/release). This can help to avoid that changes are accidently committed or even published to a wrong branch.

EXAMPLE: '.gitreview' for 'istanbul' release/branch

Update sphinx build configuration file 'conf.py' ('newbranch')

BRANCH: 'newbranch'

FILE: doc/docs/conf.py

DESCR: The Sphinx build configuration file 'conf.py' contains configuration needed to customize Sphinx input and output behavior. Please follow the instructions below.

1. On top of the file, set "branch = 'newbranch'".
2. Set 'intersphinx_mapping' for all participating projects/repositories.
3. Update 'linkcheck_ignore' entries. Replace '/latest/' with '/<newbranch>/'.

IMPORTANT: Not changing 'linkcheck_ignore' entries will lead into 'anchor issues' during the documentation build process.

Note: The different 'intersphinx_mapping' sections in the 'conf.py' represent the different state of development in the ONAP projects and their repositories. We have to differentiate between:

• Projects/repos that have created a branch for the upcoming release. That's why the entries are mapping to project documentation in the new created branch (branch = 'newbranch').
• Projects/repos that have not created a branch for the upcoming release, but for a previous release. That's why the entries are mapping to project documentation in a previous branch (e.g. branch = 'frankfurt' or branch = 'guillin').
• Projects/repos that have never created a branch. That's why the entries are mapping to project documentation in the 'master' branch of ONAP (branch = 'latest'). The ONAP 'master' branch is mapped to 'latest' in ReadTheDocs.

EXAMPLE: 'conf.py' for 'istanbul' branch/release

OPEN: Add reliable source for the info if a project has/hasn't branched.

OPEN: Include changes/actions required because we have introduced constraints-files.

OPEN: Update to 'conf.yaml' required after branching the repo?

OPEN: There are plans for upcoming releases to include only projects/repositories which are in 'maintained' state and have created a branch for the new release.

Update interactive ONAP architecture overview and related files ('newbranch')

BRANCH: 'newbranch'

FILE #1: doc/docs/guides/onap-developer/architecture/media/onap-architecture-overview-interactive.svg

FILE #2: doc/docs/guides/onap-developer/architecture/onap-architecture.rst

CONTACT: Thomas Kulik

DESCR: Please follow the instructions below.

1. PREREQUISITE: The interactive ONAP architecture overview (svg format, maintained by the 'doc' project team) must already have been aligned to the official ONAP architecture diagram maintained by the Architecture Subcommittee (e.g. Istanbul-R9 Architecture Diagram). See above.
2. Optional: Open the file 'onap-architecture-overview-labels-and-links.xlsx', change links to point to 'newbranch' and not 'latest'; check if links are reachable (to be detailed).
3. Open file 'onap-architecture-overview-interactive.svg' in Inkscape
4. In the 'Objects' window find the 'releaseinfo.link' object. Make it visible by clicking on the 'closed eye' symbol to change it to an 'open eye' symbol. Now the release info should be visible on the overview.
5. Click on tab 'Object attributes' and check the content of the field 'Href:' (the link must point to 'newbranch', not 'latest').
6. Check also the content of the field 'Title:' to show the new release number and name (e.g. 'ONAP Release 9 »Istanbul«').
7. Check and update all embedded links to point to 'newbranch' and not 'latest'. (to be detailed; search and replace in editor?)
8. Save the file.
9. Save the file a second time, but with a new filename. Use 'onap-architecture-overview-interactive-path.svg'.
10. Then select all  elements in the map and use the Inkscape function 'Path → Object to Path' to convert all elements to pathes. Read more about this in the onap-architecture-overview-notes.txt . Save the overview map, close Inkscape (and remember to do no  further changes to this 'pathed' version of the overview).
11. Info: In 'doc/docs/guides/onap-developer/architecture/onap-architecture.rst' you find a '.. raw:: html' section which contains the filename of the interactive ONAP architecture overview. You must use the filename of the 'pathed' version ('onap-architecture-overview-interactive-path.svg') here!

EXAMPLE: 'onap-architecture.rst' for 'istanbul' branch

› View in RTD

OPEN: Describe how to update and test links in xls and svg.

OPEN: Update links in 'onap-architecture-overview-interactive.svg' by using an editor and replacing very carefully '/en/latest/' with '/en/<newbranch>' ? Do all links work?