Topic | Notes | Follow-up |
---|
Release / Branching Strategy | - Amsterdam doc project branch created and tracking updates in any other repo providing documentation that has an Amsterdam branch. For those that did not have an Amsterdam branch, we are using head of the master branch as of ~11/24 4pm EST.
- branch will include only project repos that have been formally tagged by LF. Project repos that still need to be tagged:
- Where Amsterdam changes are expected and should be automatically published when merged, an Amsterdam branch may be created.
- Both master and amsterdam are being published at read the docs. The default when someone enter http://docs.onap.org is master and the the developer wiki download link currently points to master. Should we change this?
- New / updated documentation will always be in the master
- Latest version will always be in readthedocs
| - Submit Request(s) to LF to tag project repos for Amsterdam (per LF must come from project Committer or PTL?)
|
Wiki Migration | Sub Tasks for: - Setting Up ONAP
- Integrating with ONAP
- Using ONAP
- Architecture
- Documenting ONAP
- Developing ONAP
| New JIRA Issue |
Structure Clean-Up | - Developing ONAP: Structure and Headings clean-up
| New JIRA Issue |
Carrier Grade | - "Carrier Grade" usability - what does that mean for Documentation?
- Insuring standards/consistency across projects (e.g. terminology, monitoring, clustering)
- Usability (e.g. Designer, VNF Providers, Operations)
| New JIRA Issue |
APIs | - REST API
- HealthCheck API
- Components API (eg Java class API)
| New JIRA Issue |
Glossary | Modeling team responsible - Definitions to RsT
- Indexing / tagging to enable Searching
| Address during Release 2 Create JIRA issue - Greg follow up |
Tooling / Utilities documentation | How to: - Gerrit guide
- Guidelines (Builds, etc.)
- Utilities: Jenkins, Conversion tools (e.g. LFPandocs)
| New JIRA Issue (LF pursuing Quarter 3, 2018) |