TITLE | P01: Create documentation for an ONAP main release |
SUBJECT | This procedure describes the required tasks for the ONAP doc project itself and supplying parties to create release-specific documentation for an ONAP main release. |
RELEVANCE | 9.0.0 'Istanbul' - 8.0.0 'Honolulu' |
TABLE OF CONTENTS | |
AUTHOR(S) | |
TASKS | NOTE: Not every step within a single task is listed here. For example, common tasks like operations with the 'git' command (e.g. add, remove, commit, review) are not included. A development environment to write and preview reStructuredText is prerequisite, also some knowledge how to use Inkscape is required. |
01 | Update 'doc' project release notesBRANCH: master FILE: doc/docs/release-notes.rst DESCR: The file contains a description of the latest changes in the 'doc' project. Update it accordingly for the new release. EXAMPLE: 'release-notes.rst' for 'master' branch |
02 | Update 'marketing' ('composite') release notesBRANCH: master FILE: doc/docs/release/index.rst DESCR: This file contains a ('marketing') overview about the advantages and latest developments related to the new release. It is also known as the 'composite' release notes. The text is authored by LFN marketing and the ONAP TSC chair. It is provided in text form and has to be converted to reStructuredText format manually. Update the file accordingly - especially the release date. EXAMPLE: 'index.rst' for 'master' branch OPEN: Add contacts and describe the process how and when to request the 'marketing' text. Currently responsible for this activity: Eric Debeau |
03 | Update list of project specific release notesBRANCH: master FILE: doc/docs/release/releaserepos.rst DESCR: This file contains a table of contents (TOC) for project specific release notes. There are several sections to reflect the current maintenance state of every project. Whenever a project/repository is deployed via OOM (standard ONAP installation), its release note must be part of the TOC - regardless if this project/repository is currently maintained, unmaintaind or in another state. Update the file accordingly for the new release. EXAMPLE: 'releaserepos.rst' for 'master' branch OPEN: Add reliable source for 'release partizipating projects/repositories' and their 'maintenance-state' and - in addition - those ('unmaintained') projects which are deployed 'on top' by OOM team (because the projects/repos are still required for a good reason). |
04 | Create a new branch of the 'doc' project in gerritBRANCH: source/initial=master, target/new='newbranch' FILE: n/a DESCR: Please follow the instructions below.
Note: You are not allowed to delete a branch. If you need to (maybe due to a typo in the process of creation) you have to raise a ticket at the LF IT Support. OPEN: Evaluate if we can/should update all files AFTER we have created the branch (and having only 'placeholder' files in the 'master' branch). This may avoid confusion in case people are looking to 'master' and seeing release specific content (e.g. related to 'honolulu'). |
05 | Clone the new doc branch to your development environmentBRANCH: 'newbranch' FILE: all DESCR: Please follow the instructions below.
|
06 | Update Sphinx build configuration fileBRANCH: 'newbranch' FILE: doc/docs/conf.py DESCR: The Sphinx build configuration file 'conf.py' contains all configuration needed to customize Sphinx input and output behavior. Please follow the instructions below.
Note: The different 'intersphinx_mapping' sections in the 'conf.py' reflect the different state of development in the ONAP projects and their repositories. We have to differentiate between:
EXAMPLE #1: 'conf.py' for 'master' branch EXAMPLE #2: 'conf.py' for 'honolulu' branch/release
OPEN: Add reliable source for the info if a project has/hasn't branched. |
07 | Set correct 'defaultbranch' for 'gitreview'BRANCH: 'newbranch' FILE: doc/.gitreview DESCR: Add/update the 'defaultbranch' entry accordingly (e.g. 'defaultbranch=honolulu' for the 'honolulu' branch/release). This avoids people from accidently ... ? EXAMPLE: '.gitreview' for 'honolulu' release/branch
OPEN: Add a description why this is important. |
08 | Update interactive ONAP architecture overview and related filesBRANCH: 'newbranch' FILE #1: doc/docs/guides/onap-developer/architecture/media/onap-architecture-overview-r<#>-latest-interactive.svg FILE #2: doc/docs/guides/onap-developer/architecture/onap-architecture.rst DESCR: Please follow the instructions below.
EXAMPLE: 'onap-architecture.rst' for 'master' branch OPEN: Update example to 'istanbul' branch as soon as possible (pointing to 'master' is misleading here) |
xx | Template lorem ipsum dolor sit ametBRANCH: foo FILE: foo/bar.rst DESCR: Lorem ipsum dolor sit amet. EXAMPLE: 'bar.rst' for 'xyz' branch OPEN: Lorem ipsum dolor sit amet |