Versions Compared

Old Version 45

changes.mady.by.user Thomas Kulik

Saved on

compared with

New Version 46

changes.mady.by.user Thomas Kulik

Saved on

Key

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


TITLE

P01: Create documentation for an ONAP main release

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

Table of Contents
minLevel3

AUTHOR(S)

Thomas Kulik

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 <newbranch> --recurse-submodules ssh://<username>@gerrit.onap.org:29418/doc

00. Update 'doc/docs/conf.py' in the new branch

  1. Set "branch = 'newbranch'" on top of the file
  2. Set 'intersphinx_mapping' for all participating projects and their repositories
  3. Update 'linkcheck_ignore' entries if required

Note: 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. That's why the entries are mapping to their documentation in the new created branch (branch = 'newbranch').
  • Projects that have not created a branch for the upcoming release, but for a previous release. That's why the entries are mapping to their documentation in a previous branch (e.g. branch = 'frankfurt' or branch = 'guillin').
  • Projects that have never created a branch. That's why the entries are mapping to their documentation in the 'master' branch of ONAP (branch = 'latest'). The ONAP 'master' branch is called 'latest' in ReadTheDocs.

Example #1: 'conf.py' for the 'master' release/branch

Example #2: 'conf.py' for the 'honolulu' release/branch

 


00. Update 'doc/.gitreview' in the new branch

  1. Add/update the 'defaultbranch' (e.g. 'defaultbranch=honolulu')

Example: '.gitreview' for the 'honolulu' release/branch