Tracking Table
Project Name | Document Title | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices:
| Activity Planned for Release Choices:
| Preliminary Documentation New docs or new projects ONLY (enter "N/A" if not applicable, or link to gerrit if completed) | Attended Doc Hackathon 1 on March 11 (Document owner must attend at least one hackathon) (fill in green checkmark | Attended Doc Hackathon 2 on March 25 (Document owner must attend at least one hackathon) (fill in green checkmark | Link to Final Documentation in ReadTheDocs (stable/frankfurt branch) | Reviewed by the doc project (reviewed means release related content. Such as release notes and release name were applicable) By best effort! |
---|---|---|---|---|---|---|---|---|---|
M1 | M2/M3 | Post-M4 | RC0 | ||||||
CLAMP | Architecture | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/guides/onap-developer/architecture/onap-architecture.html#closed-control-loop-automation | ||||
CLAMP | User Guide | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/user-guide.html | ||||
CLAMP | Release Note | Maintained | Major Update | N/A | https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/release-notes.html#release-notes | ||||
Modeling | Model Spec | Xu Yang | Maintained | Minor Update | N/A | https://docs.onap.org/en/latest/submodules/modeling/modelspec.git/docs/index.html | |||
Modeling | ETSI Catalog | Yuanhong Deng | Maintained | Minor Update | N/A | ![]() | https://docs.onap.org/en/latest/submodules/modeling/etsicatalog.git/docs/index.html | ||
MultiCloud | Architecture | Maintained | No Change | N/A | https://docs.onap.org/en/latest/submodules/multicloud/framework.git/docs/MultiCloud-Architecture.html | ||||
MultiCloud | User Guide | Maintained | No Change | N/A | https://docs.onap.org/en/latest/submodules/multicloud/framework.git/docs/index.html#multicloud-plugins-user-guides | ||||
APPC | LCM API Guide | Takamune Cho | Maintained | Minor Update | N/A | ||||
APPC | Client Library Guide | Takamune Cho | Maintained | Minor Update | N/A | ||||
APPC | Logging Guide | Takamune Cho | Maintained | No Change | N/A | ||||
APPC | User Guide | Takamune Cho | Maintained | Minor Update | N/A | ||||
APPC | OAM API Guide | Takamune Cho | Maintained | No Change | N/A | ||||
APPC | CDT User Guide | Takamune Cho | Maintained | Minor Update | N/A | ||||
PORTAL | Release Notes | Lorraine A. Welch | Maintained | Minor Update | N/A | Did not attend | Did not attend | RC0 | |
INTEGRATION | User Guide | Maintained | Minor update | N/A | |||||
INTEGRATION | CI Guide | New | Initial publication | see OOM Gating and https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004 | |||||
POLICY | Architecture | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/latest/architecture/architecture.html | ||||
POLICY | Offered APIs | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/latest/offeredapis.html | ||||
POLICY | Development Guide | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/latest/development/development.html | ||||
EXTAPI | Architecture | Maintained | No Change | N/A | https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/architecture/architecture.html | ||||
EXTAPI | Offered APIs | Adrian OSullivan | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html | |||
EXTAPI | Consumed APIs | Adrian OSullivan | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html | |||
EXTAPI | Developer Guide | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html | ||||
EXTAPI | Installation | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/installation/installation.html | ||||
VNFSDK | Architecture | Maintained | No Change | N/A | |||||
VNFSDK | Marketplace/VTP API | Maintained | No Change | N/A | |||||
VNFSDK | User Guide | Maintained | No Change | N/A | https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html#service-orchestration | ||||
SO | API | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | https://docs.onap.org/en/latest/submodules/so.git/docs/architecture/architecture.html | |||
SO | Architecture | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | ||||
OOF | Architecture | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | ||||
OOF | Homing Specification Guide | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | ||||
OOF | API | Shankaranarayanan Puzhavakath Narayanan | Maintained | Minor update | N/A | ||||
OOM | Setup Guide | Maintained | Minor update | N/A | |||||
OOM | Release Notes | Maintained | Minor update | N/A | |||||
VF-C | Offered APIs | Yan Yang | Maintained | Minor update | N/A | ![]() | https://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.html | ||
VF-C | User Guide | Yan Yang | Maintained | Minor update | N/A | ![]() | https://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/platform/installation/user-guide/ns-instantiate-guide.html | ||
VF-C | Installation Guide | Maintained | Minor update | N/A | ![]() | https://onap.readthedocs.io/en/latest/submodules/vfc/nfvo/lcm.git/docs/platform/installation/index.html | |||
CCSDK | CDS User Guide | Maintained | Minor update | N/A | ![]() | https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html | |||
CCSDK | Release Notes | Dan Timoney | Maintained | Minor update | N/A | ![]() | https://onap-doc.readthedocs.io/projects/onap-ccsdk-distribution/en/frankfurt/release-notes.html | ||
CLI | Release Notes | Maintained | Minor Update | N/A | |||||
VVP | VNF Validation Documentation | Maintained | Minor update | NA | NA | NA | VNF Validation Documentation | ||
VNFRQTS | VNF and PNF Requirements and Guidelines | Maintained | Minor Update | NA | NA | NA | VNF and PNF Requirements and Guidelines | ||
AAI | Offered APIs | Maintained | Minor Update | N/A | |||||
AAI | AAI REST API | Maintained | Minor Update | N/A | |||||
AAI | Release Notes | Maintained | Minor Update | N/A | |||||
MUSIC | Architecture and Usage | Maintained | Minor Update | N/A | N/A | N/A | |||
SDNC | Offered APIs | Dan Timoney | Maintained | Minor Update | N/A | ![]() | https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/offeredapis.html | ||
SDNC | Release Notes | Dan Timoney | Maintained | Minor Update | N/A | ![]() | https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html | ||
DCAE | Architecture | Maintained | Minor Update | https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/architecture.html | |||||
DCAE | Release Notes | Vijay Kumar | Maintained | Minor Update | https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/release-notes.html | ||||
DCAE | Offered API's | Vijay Kumar | Maintained | Minor Update | https://gerrit.onap.org/r/#/c/dcaegen2/+/100354/ | https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/offeredapis.html | |||
DCAE | Consumed API's | Maintained | Minor Update | https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/consumedapis.html | |||||
DCAE | MOD User guide | New | Initial publication | Placeholder - DCAE MOD User Guide | https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.html | ||||
DCAE | DCAE Service Components | Maintained | Minor Update | PMSH - https://gerrit.onap.org/r/#/c/dcaegen2/+/98979/ | |||||
DCAE | Acumos Adapter | New | Initial publication | Placeholder - Acumos DCAE Integration | As this is POC, documentation will be maintained on WIKI | ||||
DMAAP | Architecture and Usage | Maintained | No Change | ||||||
DMAAP | Release Notes | Maintained | Minor Change | ||||||
VID | Release Notes | ittay | Maintained | Minor Update | n/a | ![]() | ![]() | https://docs.onap.org/en/frankfurt/submodules/vid.git/docs/release-notes.html | |
VID | Swagger API | ittay , automatically generated | Maintained | No Change | n/a | ![]() | ![]() | ||
VID | User Guide | ittay | Maintained | No Change | n/a | ![]() | ![]() | https://docs.onap.org/en/frankfurt/submodules/vid.git/docs/humaninterfaces.html | |
AAF | WIKI | Maintained | Admin/Release | Application Authorization Framework Documentation | |||||
AAF | Main Docs | Maintained | Improve (link to Swagger?)/Add new Feature info. | AAF Read-the-Docs | AAF Read-the-Docs | ||||
AAF | API Docs | Maintained | Move content to Swagger in Frankfurt | AAF API Docs has always been a code-generated part of the AAF GUI. The intention for Frankfurt is to take the Code Generation element existing, and generate Swagger. | See any AAF GUI. | ||||
Usecase-UI | Release Notes | xu ran | Maintained | Major Update | N/A | https://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/release-notes.html | |||
Usecase-UI | User Guide | Maintained | Minor Update | N/A | ![]() | https://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html | |||
Usecase-UI | Installation Guide | Maintained | Minor Update | N/A | https://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/platform/installation/installation/index.html | ||||
SDC | Release notes | Maintained | Major update | N/A | https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html | ||||
SDC | Delivery | Maintained | Minor update | N/A | https://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html | ||||
Holmes | Release Notes | Maintained | Minor update | N/A | |||||
Holmes | User Guide | Guangrong Fu | Maintained | Minor update | N/A | ||||
Holmes | Architecture | Maintained | Minor update | N/A | |||||
MSB | Release Notes | Huabing Zhao | Maintained | Minor update | N/A | ||||
MSB | User Guide | Huabing Zhao | Maintained | Minor update | N/A | ||||
MSB | Architecture | Huabing Zhao | Maintained | Minor update | N/A |
Procedure
M1
- Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
- In the table above, fill in
- project name
- doc title,
- doc owner (use Confluence @ notation for name, e.g., David McBride)
- current doc state
- activity planned for release
- Update status of JIRA task as Done
M2/M3
- Find JIRA task attached to M2 Epic for your project, if you haven't already done so.
- Note that this task applies to new documents only (i.e., "New" in Current Document State column). If this is not a new document, just enter "N/A" in the Preliminary Documentation Completed column in the table above.
- For new documents, at a minimum create a placeholder document (e.g., document with a title, or an outline), and commit to the repo. Add a link to the gerrit to the Preliminary Documentation column in the table above.
- Update the status of the JIRA task as Done.
Post M4
- Find the dates for the two documentation hackathons.
- The document owner should plan on attending at least one of the two hackathons.
- Enter a green checkmark in the appropriate column in the table above for the hackathon that was attended.
RC0
- Find JIRA task attached to RC0 Epic for your project, if you haven't already done so.
- Add a link to the document in ReadTheDocs in the appropriate column in the table above.
- Update the status of the JIRA task as Done.