NOTE: This document complements: Increased transparency on software modules included in an ONAP release
TABLE OF CONTENTS
Architecture descriptionObservationResponsibilities 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: Suggestion for Improvement
|
Marketing/Composite release noteObservationResponsibilities 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
|
Branching of repositoriesObservationSee Increased transparency on software modules included in an ONAP release Suggestion for Improvement |
Management of ONAP projects/software modules participating in a releaseObservationSee Increased transparency on software modules included in an ONAP release Suggestion for Improvement |
Process description for 'doc' project team to create ONAP documentation ObservationFor the 'doc' project team there is no clear set of instructions to create the release specific documentation for an ONAP release. Suggestion for Improvement
|
Process description for ONAP project teams to create project documentationObservationFor 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
|
Sphinx configuration files for ONAP project teamsObservationThere is no guidance for ONAP project teams how to configure sphinx and related functions properly to ensure a working documentation build process. Previous config not robust for changes of LFIT / required libraries (lfdocs-conf) Related files (examples taken from the vfc/nfvo/lcm repository):
Suggestion for Improvement
|
Documentation comes late in the release processObservationDocumentation comes late in the release process and the 'doc' project team has only limited resources to handle all the activity close to the release date Suggestion for Improvement
|
Gating process for changes in LFIT librariesObservationmissing / untested changes Suggestion for Improvement
|
readthedocs / new (sub)project / add doc contributer as maintainer automaticallyObservationto Suggestion for Improvement
|