You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 38 Next »


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

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. Modify 'doc/docs/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. We are mapping to their documentation in the new created branch.
  • Projects that have not created a branch for the upcoming release, but for an previous release. We are mapping to their documentation in the previous branch.
  • Projects that have never created a branch. 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.

  • No labels