...
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 | Note: Not every step within a single task is listed here. For example, a detailed description of a 'git commit' and the following 'git review' process is not explained. | ||||
0x. Update 'doc/docs/release-notes.rst' in the 'master' branch
Example: 'release-notes.rst' in the 'master' release/branch | |||||
0x01. Create a new branch of the 'doc' project in gerrit
| |||||
000x. Clone the new doc branch to your development environment
| |||||
00 0x. Update 'doc/docs/conf.py' in the new branch
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:
Example #1: 'conf.py' for the 'master' release/branchExample #2: 'conf.py' for the 'honolulu' release/branch
| |||||
00 0x. Update 'doc/.gitreview' in the new branch
Example: '.gitreview' for the 'honolulu' release/branch
| |||||
0x. Lorem ipsum dolor sit amet
|