Release activities for Frankfurt
- Devision between wiki and RTD
- Template improvements
- Revise the milestone plan for documentation (See issues below)
- Submodule removal - get an understanding of the effort
- Two major goals for documentation for Frankfurt:
- David McBride Add JIRA tickets for milestone requirements (see below)
- Sofia Wallin propose release notes template and present to PTL/TSC (approval?)
Maintenance:
- Following as close as possible the same contribution process & tools as our source code
- Develop initial set of release documents such as release notes and ONAP overview
- Provide language guidance. All documents should be written in English.
- Provide processes and tooling for ONAP projects to implement and follow for consistency
- Support projects to achieve any documentation related milestone
Issues
- Insufficiently detailed/comprehensive milestone requirements for documentation
- Summary of current documentation requirements in relman
- M2/3 - API documentation complete
- RC0 epic - change description to emphasize project ownership of documentation
- Task - update release notes and documentation
- breakout documentation requirements and add detail
- Task - update release notes and documentation
- Only hard requirements for release notes and for API documentation. Not comprehensive or detailed.
- Summary of current documentation requirements in relman
- Do we need to create templates?
- Should the documentation guide be updated?
- Template for release notes?
What milestone requirements should we have for documentation?
- M1
- Each project should include an inventory of documentation.
- Create a table in the wiki for projects to complete as a requirement for M1
- List of documentation maintained by the project
- For each: new, will be updated, no change
- Status: not started, in-process, completed
- Create a table in the wiki for projects to complete as a requirement for M1
- Identify individual to drive documentation for the project. Add name to table ^^
- Each project should include an inventory of documentation.
- M2 / M3
- Preliminary documentation for new projects or documents
- at minimum, placeholder documents committed to repo
- Preliminary documentation for new projects or documents
- M4
- Get dates for doc hackathons and schedule rep to attend at least one.
- Track attendance in table?
- Get dates for doc hackathons and schedule rep to attend at least one.
- RC0
- Documentation review with PTLs/TSC
- Review status of documentation based on information reported by projects in tracking table
- Implement any needed corrections or updates
- Documentation review with PTLs/TSC
- RC1
- Documentation completed
- Add link to final documentation published on read-the-docs
- Reviewed, approved and cherry picked to release branch.
- Add link to final documentation published on read-the-docs
- Documentation completed
Detailed backlog to be defined in Jira