Table of Contents |
---|
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 | RC2 | ||||||
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 | Release date need to be updated | ||||
Modeling | Model Spec | Xu Yang | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/submodules/modeling/modelspec.git/docs/index.html | Still reference to Dublin No Frankfurt branch | |||
Modeling | ETSI Catalog | Yuanhong Deng | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/submodules/modeling/etsicatalog.git/docs/index.html | OK, with RST file in gerrit, but pb with Frankfurt link: https://docs.onap.org/en/frankfurt/submodules/modeling/etsicatalog.git/docs/index.html | |||
MultiCloud | Architecture | Maintained | No Change | N/A | https://docs.onap.org/en/frankfurt/submodules/multicloud/framework.git/docs/MultiCloud-Architecture.html | No Frankfurt Branch ! Still API V1 vesion documented | ||||
MultiCloud | User Guide | Maintained | No Change | N/A | https://docs.onap.org/en/frankfurt/submodules/multicloud/framework.git/docs/index.html#multicloud-plugins-user-guides | No Frankfurt Branch ! Still API V1 vesion documented | ||||
APPC | LCM API Guide | Takamune Cho | Maintained | Minor Update | N/A | https://onap-doc.readthedocs.io/projects/onap-appc/en/frankfurt/APPC-LCM-API-Guide/APPC-LCM-API-Guide.html | ||||
APPC | Client Library Guide | Takamune Cho | Maintained | Minor Update | N/A | |||||
APPC | Logging Guide | Takamune Cho | Maintained | No Change | N/A | https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-Logging-Guide/APPC-Logging-Guide.html | ||||
APPC | User Guide | Takamune Cho | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-User-Guide/APPC-User-Guide.html | ||||
APPC | OAM API Guide | Takamune Cho | Maintained | No Change | N/A | https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-OAM-API-Guide/APPC-OAM-API-Guide.html | ||||
APPC | CDT User Guide | Takamune Cho | Maintained | Minor Update | N/A | https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-CTD-Guide/APPC-CDT-Guide.html | ||||
PORTAL | Release Notes | Lorraine Welch | Maintained | Minor Update | N/A |
Minor Update | N/A | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html | Link to http, no https - http still supported locally | ||
EXTAPI | Installation | Maintained |
Minor Update | N/A | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html | https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html | Still http Adrian OSullivan when running and testing local docker it is http, https only for OOM install v4 ok ? Adrian OSullivan Yes | ||
VNFSDK | Architecture |
Maintained | Minor update | N/A | https://onap-doc.readthedocs.io/projects/onap-oom/en/latest/index.html#master-index | |||||
OOM | Release Notes |
Maintained | Minor update | N/A | ||||||||
VF-C | Offered APIs | Yan Yang | Maintained | Minor update | N/A | https://onap.readthedocs.io/en/frankfurt/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/frankfurt/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/frankfurt/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 |
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
...