Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.


TASKS

01. Create a new branch of the doc project in gerrit

  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

00. Clone the new doc branch to your development environment

  1. git clone --branch <branch> --recurse-submodules ssh://<username>@gerrit.onap.org:29418/doc

00. Modify '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 state of development in the projects and their repositories. We have to differentiate between:

  • Projects that have created a branch for the upcoming release. So we are mapping to their documentation in this new created branch.
  • Projects that have not created a branch for the upcoming release, but for an previous release. So we are mapping to their documentation in the previous branch.
  • Projects that have never created a branch. So we are mapping to their documentation in the 'master' branch of ONAP (called 'latest' in ReadTheDocs).
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.

x