...
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 <date> (Document owner must attend at least one hackathon) (fill in green checkmark | Attended Doc Hackathon 2 on <date> (Document owner must attend at least one hackathon) (fill in green checkmark | 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 | Maintained | No Change | N/A | CLAMP Architecture | ||||||
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 | https://docs.onap.org/projects/onap-holmes-rule-management/en/guilin/platform/installation.html | ||||||
Modeling | Architecture | Yuanhong Deng | Maintained | Minor Update | N/A | ||||||
Modeling | Offered APIs | Yuanhong Deng | Maintained | Minor Update | N/A | ||||||
OOF | Architecture | Maintained | Minor Update | N/A | OOF Architecture | ||||||
OOF | Offered APIs | Maintained | Minor Update | N/A | OOF Offered APIs | ||||||
OOF | Release Notes | Maintained | Minor Update | N/A | OOF Release Notes |
| |||||
VFC | Offered APIs | Yuanhong Deng | Maintained | Minor Update | N/A | ||||||
SO | Architecture | Seshu Kumar Mudiganti | Maintained | Minor Update | N/A | ||||||
SO | Offered APIs | Maintained | Minor Update | N/A | |||||||
SO | Development Guide | Maintained | Minor Update | N/A | |||||||
VID | Release Notes | Ittay Stern | Maintained | Minor Update | N/A | https://docs.onap.org/projects/onap-vid/en/guilin/release-notes.html#release-notes | |||||
VID | Swagger API | Ittay Stern , automatically generated | Maintained | No Change | N/A | ||||||
VID | User Guide | Ittay Stern | Maintained | No Change | N/A | ||||||
Usecase UI | Release Notes | Maintained | Minor Update | N/A | Usecase-UI Release Notes | ||||||
Usecase UI | User Guide | Maintained | Minor Update | N/A | https://docs.onap.org/projects/onap-usecase-ui/en/guilin/platform/installation/user-guide/uui-guide.html | ||||||
Usecase UI | Installation Guide | Maintained | No Change | N/A | https://docs.onap.org/projects/onap-usecase-ui/en/guilin/platform/installation/installation/uui-over-oom.html | ||||||
SDC | Architecture | Christophe Closset | Maintained | Minor Update | N/A | SDC Documentation | |||||
SDC | Release Notes | Maintained | Minor Update | N/A | SDC Release Note | ||||||
AAI | Offered APIs | Maintained | Minor Update | https://docs.onap.org/projects/onap-aai-aai-common/en/guilin/AAI%20REST%20API%20Documentation/AAIRESTAPI.html#aai-api-definition | |||||||
AAI | AAI REST API | William Reehil | Maintained | Minor Update | https://docs.onap.org/projects/onap-aai-aai-common/en/guilin/AAI%20REST%20API%20Documentation/AAIRESTAPI.html#aai-rest-api | ||||||
AAI | Release Notes | William Reehil | Maintained | Minor Update | https://docs.onap.org/projects/onap-aai-aai-common/en/guilin/release-notes.html | ||||||
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 | https://docs.onap.org/projects/onap-vnfsdk-model/en/latest/release-notes.html#release-notes | ||||||
DCAE | Architecture | Maintained | Minor Update | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/architecture.html | |||||||
DCAE | Release Notes | Vijay Venkatesh Kumar | Maintained | Minor Update | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/release-notes.html#release-notes | ||||||
DCAE | Offered API's | Vijay Venkatesh Kumar | Maintained | Minor Update | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/offeredapis.html | ||||||
DCAE | Consumed API's | Maintained | Minor Update | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/consumedapis.html | |||||||
DCAE | Dashboard User guide | New | Initial Publication | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/platform-doc/dcaedashboard_userguide.html | |||||||
DCAE | MOD User guide | Maintained | Minor UpdateNo Change | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.html | |||||||
DCAE | DCAE Service Components | Maintained | Minor Update on existing components + new New Guilin components | https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/services/serviceindex.html New - https://docs.onap.org/projects/onap-dcaegen2/en/guilin/sections/services/datalake-handler/index.html | |||||||
VVP | VVP Documentation | steven stark | Maintained | Minor Update | N/A | ||||||
VNFRQTS | Provider Docs | Trevor Lovett | Maintained | Minor Update | |||||||
DMAAP | Architecture and Usage | Mandar Sawant | Maintained | No Change | N/A | ||||||
DMAAP | Release Notes | Mandar Sawant | Maintained | Minor Change | N/A | ||||||
PORTAL | Release Notes | Maintained | Major Update | N/A | https://docs.onap.org/projects/onap-portal/en/guilin/release-notes.html | ||||||
CCSDK | ORAN-A1 User Guide | New | Initial Publication | ||||||||
CCSDK | CDS User Guide | Maintained | Minor update | N/A | CDS User Guide | ||||||
CCSDK | Release Notes | Dan Timoney | Maintained | Minor update | N/A | CCSDK Release Notes | |||||
SDNC | Offered APIs | Dan Timoney | Maintained | Minor Update | SDNC Offered Apis | ||||||
SDNC | Release Notes | Dan Timoney | Maintained | Minor Update | N/A | https://docs.onap.org/projects/onap-sdnc-oam/en/guilin/release-notes.html | |||||
DOC | Release Notes | Sofia Wallin | Maintained | Minor Update | N/A | https://docs.onap.org/en/guilin/release-notes.html#doc-release-notes | |||||
DOC | Landing page | Sofia Wallin | Maintained | Minor Update | N/A | https://docs.onap.org/en/guilin/index.html | |||||
DOC | Composite release note | Maintained | Minor Update | N/A | https://docs.onap.org/en/guilin/release/index.html#onap-release-notes | ||||||
DOC | ONAP User Guides | Sofia Wallin | Maintained | Minor Update | N/A | ||||||
DOC | ONAP Operation Guides | Sofia Wallin | Maintained | Minor Update | N/A | ||||||
OOM | Setup Guide | Maintained | Minor Update | N/A | |||||||
OOM | Release Notes | Maintained | Minor Update | N/A | https://docs.onap.org/projects/onap-oom/en/guilin/release-notes.html#release-notes | ||||||
EXTAPI | Architecture | Adrian OSullivan | Maintained | No Change | N/A | Architecture Guide | |||||
EXTAPI | Offered APIs | Adrian OSullivan | Maintained | Minor Update | N/A | Offered APIs | |||||
EXTAPI | Consumed APIs | Adrian OSullivan | Maintained | Minor Update | N/A | Consumed APIs | |||||
EXTAPI | Installation | Maintained | No Change | N/A | Installation | ||||||
EXTAPI | Developer Guide | Maintained | No Change | N/A | Developer Guide | ||||||
MSB | Architecture | user-9823d | Maintained | No Change | N/A | ||||||
MSB | Offered APIs | user-9823d | Maintained | No Change | N/A | Offered APIs | |||||
MSB | Consumed APIs | user-9823d | Maintained | No Change | N/A | In the Amsterdam release, MSB does not consume any APIs provided by other ONAP components. | |||||
Installation | user-9823d | Maintained | No Change | N/A | Installation |
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
...