Table of Contents |
---|
Project Name | Document Title | Part of Guilin | RST-File | RTD-Link | 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 <date> (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Attended Doc Hackathon 2 on <date> (Document owner must attend at least one hackathon) (fill in green checkmark if attended) | Link to Final Documentation in ReadTheDocs (stable/guilin 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 | RC2 | ||||||||||
CLAMP | Architecture | https://git.onap.org/clamp/tree/docs | https://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index | Maintained | Minor Update | N/A | |||||||
CLAMP | Release Notes | https://git.onap.org/clamp/tree/docs/release-notes.rst | https://docs.onap.org/projects/onap-clamp/en/guilin/release-notes.html#release-notes | ||||||||||
POLICY | Architecture | https://git.onap.org/policy/parent/tree/docs | https://docs.onap.org/projects/onap-policy-parent/en/latest/architecture/architecture.html | Maintained | Minor Update | N/A | |||||||
POLICY | Offered APIs | https://git.onap.org/policy/parent/tree/docs | https://docs.onap.org/projects/onap-policy-parent/en/latest/offeredapis.html | Maintained | Minor Update | N/A | |||||||
POLICY | Development Guide | https://git.onap.org/policy/parent/tree/docs | https://docs.onap.org/projects/onap-policy-parent/en/latest/design/design.html | Maintained | Minor Update | N/A |
POLICY |
Release Notes | https://git.onap.org/ |
policy/ |
parent/tree/docs/ |
release-notes.rst | https://docs.onap.org/projects/onap- |
policy- |
parent/en/ |
Maintained | No Change | N/A | |||||||||||
HOLMES | Offered APIs | https://git.onap.org/holmes/rule-management/tree/docs/platform/offeredapis.rst | https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/offeredapis.html | Maintained | No Change | N/A | |||||||
HOLMES | Consumed APIs | https://git.onap.org/holmes/rule-management/tree/docs/platform/consumedapis.rst | https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/consumedapis.html | Maintained | Minor Update | N/A | |||||||
HOLMES | Installation | https://git.onap.org/holmes/rule-management/tree/docs/platform/installation.rst | https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/installation.html | Maintained | Minor Update | N/A | |||||||
HOLMES | Release Notes | https://git.onap.org/holmes/rule-management/tree/docs/release-notes.rst | https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/release-notes.html | Maintained | |||||||||
HOLMES | Engine Management |
https://git.onap.org/holmes/engine-management/tree/docs | https://docs.onap.org/projects/onap-holmes-engine-management/en/latest/index.html#master-index | Maintained | |||||||||||
Modeling | EtsiCatalog Architecture | https://git.onap.org/modeling/etsicatalog/tree/docs/architecture.rst | https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/architecture.html | Maintained | Minor Update | N/A | |||||||
Modeling | EtsiCatalog Offered APIs | https://git.onap.org/modeling/etsicatalog/tree/docs/offeredapis.rst | https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/offeredapis.html | Maintained | Minor Update | N/A | |||||||
Modeling | EtsiCatalog Release Notes | https://git.onap.org/modeling/etsicatalog/tree/docs/release-notes.rst | https://docs.onap.org/projects/onap-modeling-etsicatalog/en/latest/release-notes.html | ||||||||||
Modelling SubCom | Modelling Specifications | https://git.onap.org/modeling/modelspec/tree/docs | https://docs.onap.org/projects/onap-modeling-modelspec/en/latest/ONAP%20Model%20Spec/index.html |
Xu Yang | ||||||||
Modelling SubCom | Release Notes | https://git.onap.org/modeling/modelspec/tree/docs/Release-notes | https://docs.onap.org/projects/onap-modeling-modelspec/en/latest/Release-notes/release-notes.html |
VFC |
VNFM drivers |
https://git.onap.org/ |
vfc/ |
nfvo/driver/vnfm/svnfm/tree/docs | Not Linked | |||||||||
SO | Architecture |
https://git.onap.org/so/tree/docs | https://docs.onap.org/projects/onap-so/en/latest/architecture/architecture.html | Maintained | Minor Update | N/A | |||||||||
SO | Offered APIs | https://git.onap.org/so/tree/docs | https://docs.onap.org/projects/onap-so/en/latest/api/offered_consumed_apis.html | Maintained | Minor Update | N/A | |||||||
SO | Development Guide | https://git.onap.org/so/tree/docs | https://docs.onap.org/projects/onap-so/en/latest/developer_info/developer_information.html | Maintained | Minor Update | N/A | |||||||
SO | SO Client Libraries |
SDC |
Workflow Designer |
https://git.onap.org/ |
sdc/ |
sdc-workflow- |
designer/tree/docs |
SDC | TOSCA Parser | https:// |
git.onap.org/ |
sdc/ |
sdc-tosca/tree/docs | |||||||||||||
SDC | Distribution Client | https://git.onap.org/sdc/sdc-distribution-client/tree/docs | |||||||||||
SDC | Docker Base | https://git.onap.org/sdc/sdc-docker-base/tree/docs | |||||||||||
AAI | Offered APIs | https://git.onap.org/aai/aai-common/tree/docs/ |
platform | https://docs.onap.org/projects/onap-aai-aai-common/en/latest/ |
index.html#master-index | Maintained | Minor Update | |||||||
AAI |
AAI REST API | https://git.onap.org/aai/aai-common/tree/docs/ |
AAI%20REST%20API%20Documentation | https://docs.onap.org/projects/onap-aai-aai-common/en/latest/AAI%20REST%20API%20Documentation/ |
AAIRESTAPI.html | Maintained | Minor Update | |||||||
AAI |
Release Notes |
https://git.onap.org/aai/ |
aai- |
common/tree/docs/release-notes.rst | https://docs.onap.org/projects/onap-aai- |
aai- |
common/en/latest/ |
release-notes.html | Maintained | Minor Update |
AAI | ESR |
GUI |
https://git.onap.org/aai/esr- |
gui/tree/docs | https://docs.onap.org/projects/onap-aai-esr- |
gui/en/latest/index.html#master-index | ? | ||||||||
AAI |
ESR Server |
https://git.onap.org/aai/ |
esr- |
server/tree/docs | https://docs.onap.org/projects/onap-aai- |
esr- |
server/en/latest/index.html#master-index | |||||||||
AAI |
Event Client Documentation Repository
Sparky BE Server |
https:// |
git.onap.org/ |
aai/ |
sparky-be/tree/docs | https://docs.onap.org/projects/onap-aai- |
sparky- |
be/en/latest/index.html#master-index |
AAI | Event Client Documentation Repository | https://git.onap.org/aai/event-client/tree/docs | https://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-index | ||||||||||
Integration | Release Notes | https://git.onap.org/integration/tree/docs/release-notes.rst | https://docs.onap.org/projects/onap-integration/en/latest/release-notes.html#release-notes | Maintained | Minor Update | Release Notes not in Guide | |||||||
Integration | User Guide including use case documentation | https://git.onap.org/integration/tree/docs https://git.onap.org/integration/tree/docs/docs_usecases.rst | https://docs.onap.org/projects/onap-integration/en/latest/onap-integration-ci.html#integration-ci https://docs.onap.org/projects/onap-integration/en/latest/docs_usecases.html#docs-usecases | Maintained | Minor Update | ||||||||
Integration | Test Developer Guide |
New | Initial Publication | ||||||||||||
MultiCloud | Architecture | https://git.onap.org/multicloud/framework/tree/docs | https://docs.onap.org/projects/onap-multicloud-framework/en/latest/MultiCloud-Architecture.html | Maintained | No Change | N/A | |||||||
MultiCloud | REST API | https://git.onap.org/multicloud/framework/tree/docs | https://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html#master-index | Maintained | No Change | N/A | |||||||
MultiCloud | User Guide | https://git.onap.org/multicloud/framework/tree/docs | https://docs.onap.org/projects/onap-multicloud-framework/en/latest/index.html#master-index | Maintained | No Change | N/A |
MultilCloud | Release Notes | https://git.onap.org/multicloud/framework/tree/docs/Release%20Notes.rst | https://docs.onap.org/projects/onap-multicloud-framework/en/latest/Release%20Notes.html |
MultiCloud | Kubernetes Plugin |
https://git.onap.org/ |
multicloud/k8s/tree/docs |
https://git.onap.org/ccsdk/dashboard/tree/docs | https://docs.onap.org/projects/onap-ccsdk-dashboard/en/latest/index.html#master-index | ||||||||||
CCSDK | CCSDK Platform Plugins |
https://git.onap.org/ccsdk/platform/plugins/tree/docs | https://docs.onap.org/projects/onap-ccsdk-platform-plugins/en/latest/index.html#master-index | ||||||||||
CCSDK | CCSDK APPS |
https://git.onap.org/ccsdk/apps/tree/docs | https://docs.onap.org/projects/onap-ccsdk-apps/en/latest/index.html#master-index | ||||||||||
CCSDK | ORAN |
https://git.onap.org/ccsdk/oran/tree/docs | |||||||||||
CCSDK | SDN-R |
? | ||||||||
OOM | Offline Installer |
https://git.onap.org/ |
oom/ |
offline-installer/tree/docs | https:/ |
https://git.onap.org/msb/swagger-sdk/tree/docs | https://docs.onap.org/projects/onap-msb-swagger-sdk/en/latest/index.html#master-index |
MSB |
Java SDK |
https://git.onap.org/ |
msb/ |
java-sdk/tree/docs | ||||||||||
MSB | Discovery | https:// |
git.onap.org/ |
AAF |
Certification Service |
https://git.onap.org/aaf/ |
certservice/tree/docs | https://docs.onap.org/projects/onap- |
aaf- |
certservice/en/ |
frankfurt/index.html#master-index |
Logging |
Logging Guide |
https://git.onap.org/ |
logging-analytics/tree/docs | https://docs.onap.org/projects/onap-logging- |
analytics/en/latest/index.html#master-index | |||||||||
MUSIC |
Developer Doc |
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
...