Project Name | Document Title | RST-File | RTD-Link | Document Owner (name - use @ notation) | Current Document State (as of M1) Choices: | Activity Planned for Release Choices: - Initial Publication
- Major Update
- Minor Update
- No Change
| 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 |
|
|
|
|
|
| POLICY | Architecture |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| POLICY | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| POLICY | Development Guide |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| HOLMES | Architecture |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| HOLMES | Offered APIs |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| HOLMES | Consumed APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| HOLMES | Installation |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| Modeling | Architecture |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| Modeling | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| OOF | Architecture |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| OOF | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| OOF | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| VFC | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| SO | Architecture |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| SO | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| SO | Development Guide |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| VID | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| VID | Swagger API |
|
| Ittay Stern , automatically generated | Maintained | No Change | N/A |
|
|
|
|
|
| VID | User Guide |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| Usecase UI | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| Usecase UI | User Guide |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| Usecase UI | Installation Guide |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| SDC | Architecture |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| SDC | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| 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 | 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://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-index | https://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
| Integration | Release Notes |
|
| | Maintained | Minor Update |
|
|
|
|
|
|
| Integration | User Guide including use case documentation |
|
| | Maintained | Minor Update |
|
|
|
|
|
|
| Integration | Test Developer Guide |
|
| | New | Initial Publication |
|
|
|
|
|
|
| MultiCloud | Architecture |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MultiCloud | RESP API |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MultiCloud | User Guild |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| ONAP CLI | Release notes |
|
| | Maintained | Minot updates | N/A |
|
|
|
|
|
| VNFSDK | release notes API |
|
| | Maintained | Minot updates | N/A |
|
|
|
|
|
| DCAE | Architecture | https://git.onap.org/dcaegen2/tree/docs | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/architecture.html | | Maintained | Minor Update |
|
|
|
|
|
|
| DCAE | Release Notes | https://git.onap.org/dcaegen2/tree/docs | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.html | | Maintained | Minor Update |
|
|
|
|
|
|
| DCAE | Offered API's | https://git.onap.org/dcaegen2/tree/docs | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/offeredapis.html | | Maintained | Minor Update |
|
|
|
|
|
|
| DCAE | Consumed API's | https://git.onap.org/dcaegen2/tree/docs | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/consumedapis.html | | Maintained | Minor Update |
|
|
|
|
|
|
| DCAE | MOD User guide | https://git.onap.org/dcaegen2/tree/docs/sections/design-components/DCAE-MOD | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/index-onboarding.html | | Maintained | Minor Update |
|
|
|
|
|
|
| DCAE | DCAE Service Components | https://git.onap.org/dcaegen2/tree/docs/sections/services | https://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html | | Maintained | Minor Update on existing components + new Guilin components |
|
|
|
|
|
|
| VVP | VVP Documentation |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| VNFRQTS | Provider Docs |
|
| | Maintained | Minor Update |
|
|
|
|
|
|
| DMAAP | Architecture and Usage |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| DMAAP | Release Notes |
|
| | Maintained | Minor Change | N/A |
|
|
|
|
|
| PORTAL | Release Notes |
|
| | Maintained | Major Update | N/A |
|
|
|
|
|
| CCSDK | CDS User Guide | https://git.onap.org/ccsdk/cds/tree/docs | https://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html#master-index | | Maintained | Minor update | N/A |
|
|
|
|
|
| CCSDK | Release Notes | https://git.onap.org/ccsdk/distribution/tree/docs | https://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/release-notes.html | | Maintained | Minor update | N/A |
|
|
|
|
|
| CCSDK | Common Controller Dashboard | 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 |
|
|
|
|
|
|
|
|
|
|
| SDNC | Offered APIs |
|
| | Maintained | Minor Update |
|
|
|
|
|
|
| SDNC | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | Release Notes | https://git.onap.org/doc/tree/docs/release-notes.rst | https://docs.onap.org/en/latest/release/index.html | | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | Landing page | https://git.onap.org/doc/tree/docs | https://docs.onap.org/en/latest/index.html | | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | Composite release note | https://git.onap.org/doc/tree/docs/release | https://docs.onap.org/en/latest/release/releaserepos.html#doc-releaserepos | | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | ONAP User Guides | https://git.onap.org/doc/tree/docs/guides/onap-user | https://docs.onap.org/en/latest/guides/onap-user/index.html | | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | ONAP Operation Guides | https://git.onap.org/doc/tree/docs/guides/onap-operator | https://docs.onap.org/en/latest/guides/onap-operator/index.html | | Maintained | Minor Update | N/A |
|
|
|
|
|
| DOC | RST Templates | https://git.onap.org/doc/tree/docs/templates |
| Sofia Wallin |
|
|
|
|
|
|
|
|
| DOC | DOC Developer Guide | https://git.onap.org/doc/tree/docs/guides/onap-developer/how-to-use-docs | https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html | |
|
|
|
|
|
|
|
|
DOC
(ARC) | API Reference | https://git.onap.org/doc/tree/docs/guides/onap-developer/apiref | https://docs.onap.org/en/latest/guides/onap-developer/apiref/index.html | |
|
|
|
|
|
|
|
|
| DOC | ONAP Tutorials | https://git.onap.org/doc/tree/docs/guides/onap-developer/tutorials | https://docs.onap.org/en/latest/guides/onap-developer/tutorials/index.html | ? |
|
|
|
|
|
|
|
|
| DOC | ONAP Component Document Index | https://git.onap.org/doc/tree/docs/guides/onap-developer/developing | https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html https://git.onap.org/doc/log/docs/conf.py | |
|
|
|
|
|
|
|
|
DOC
(ARC) | ONAP Architecture | https://git.onap.org/doc/tree/docs/guides/onap-developer/architecture | https://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html | |
|
|
|
|
|
|
|
|
DOC
(ARC) | ONAP Overview | https://git.onap.org/doc/tree/docs/guides/overview | https://docs.onap.org/en/latest/guides/overview/index.html | ? |
|
|
|
|
|
|
|
|
| OOM | Setup Guide |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| OOM | Release Notes |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| EXTAPI | Architecture |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| EXTAPI | Offered APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| EXTAPI | Consumed APIs |
|
| | Maintained | Minor Update | N/A |
|
|
|
|
|
| EXTAPI | Installation |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| EXTAPI | Developer Guide |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MSB | Architecture |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MSB | Offered APIs |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MSB | Consumed APIs |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| MSB | Installation |
|
| | Maintained | No Change | N/A |
|
|
|
|
|
| APPC | APPC Deployment | https://git.onap.org/appc/deployment/tree/docs | https://docs.onap.org/projects/onap-appc-deployment/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
| APPC | APPC Documentation | https://git.onap.org/appc/tree/docs | https://docs.onap.org/projects/onap-appc/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
| AAF | Application Authorization Framework | https://git.onap.org/aaf/authz/tree/docs | https://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
| AAF | Secret Management Service | https://git.onap.org/aaf/sms/tree/docs | https://docs.onap.org/projects/onap-aaf-sms/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
| CLI | Command Line interface | https://git.onap.org/cli/tree/docs | https://docs.onap.org/projects/onap-cli/en/latest/index.html#master-index |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
