You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 43
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) | |
TASKS | 01. Create a new branch of the 'doc' project in gerrit- Open https://gerrit.onap.org/r/admin/repos/doc,branches
- Use [CREATE NEW] function on the top right corner
- Set 'Branch name' to the name of the upcoming release (e.g. 'istanbul')
- Set 'Initial revision' to 'master'
- Use [CREATE] to create the new branch
|
| 00. Clone the new doc branch to your development environment- git clone --branch <newbranch> --recurse-submodules ssh://<username>@gerrit.onap.org:29418/doc
|
| 00. Edit 'doc/docs/conf.py'- Set 'branch' on top of the file
- Set 'intersphinx_mapping' for all participating projects and their repositories
- 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 the previous branch (e.g. branch = 'frankfurt').
- 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/branchExample #2: 'conf.py' for the 'honolulu' release/branch |
| 00. Lorem ipsum dolorLorem 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 dolorLorem 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. |