Istanbul Documentation: Lessons Learned

Architecture description

Observation

Responsibilities and delivery process unclear. Stakeholders and tasks are not covered by the release process. Updates for the architecture description must be manually inquired from the Architecture Subcommittee and LFN Marketing and hence are provided late in the release process.

Relevant files:

• ONAP Overview [GIT] [RTD]
• ONAP Architecture [GIT] [RTD]

Suggestion for Improvement

• todo

Marketing/Composite release note

Observation

Responsibilities and delivery process unclear. Stakeholders and tasks are not covered by the release process.

Who is in the lead to use the content provided in the 'Release Key Updates' to create the Marketing/Composite Release Note?

Content in 'Release Key Updates' (e.g. for the 'istanbul' release) is partly not provided by the projects/subcommittees. Partly it must be rephrased to be used in the Marketing/Composite Release Note.

Suggestion for Improvement

• todo

Branching of repositories

Observation

See Increased transparency on software modules included in an ONAP release

Suggestion for Improvement

• See Increased transparency on software modules included in an ONAP release

Management of ONAP projects/software modules participating in a release

Observation

See Increased transparency on software modules included in an ONAP release

Suggestion for Improvement

• See Increased transparency on software modules included in an ONAP release

Process description for 'doc' project team to create ONAP documentation

Observation

For the 'doc' project team there is no clear set of instructions to create the release specific documentation for an ONAP release.

Suggestion for Improvement

• 'doc' team to describe the process from a 'doc' project point of view and to provide this set of instructions in the ONAP Dev Wiki. See P01: Create documentation for an ONAP release (doc project team)

Process description for ONAP project teams to create project documentation

Observation

For the ONAP project teams there is no clear set of instructions to create the release specific project documentation for an ONAP release.

Suggestion for Improvement

• 'doc' team to describe the process from an ONAP project point of view and to provide this set of instructions in the ONAP Dev Wiki. See P02: Create documentation for an ONAP release (ONAP project teams)

Sphinx configuration files for ONAP project teams

Observation

There is no guidance for ONAP project teams how to configure sphinx and related fuctions properly to ensure a working documentation build process.

Suggestion for Improvement

• 'doc' team to provide ...

Documentation late in the release process

Observation

x

Suggestion for Improvement

• x