Page History

Subject

This procedure describes the required tasks for the ONAP doc project itself and supplying ONAP projects to create release-specific documentation for an ONAP main release.

Table of Contents

Author(s)

Thomas Kulik

Tasks

01. Create new branch of the doc project

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 ?
5. Use [CREATE] to create the branch

00. Maintain 'conf.py'

1. Set 'branch'
2. Set 'intersphinx_mapping' for all participating projects and their repositories.
3. Update 'linkcheck_ignore' entries if required.

The different 'intersphinx_mapping' sections in the 'conf.py' reflect the different states of development for documentation in the respective projects and their repositories.  This are:

• Projects that have created a branch. So we are linking to the branch.
• Projects 

Example: 'conf.py' (R8 »Honolulu«)

00. Lorem ipsum dolor

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.

00.00 Lorem ipsum dolor

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.