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 | 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 | 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 | https://git.onap.org/holmes/rule-management/tree/docs/platform/architecture.rst | https://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/architecture.html | 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 | ||||||||||
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 | |||||||||
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 |
Ittay Stern , automatically generated
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 | 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 | Modelling SC | |||||||||
Modelling | 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 | Modelling SC | |||||||||
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 |
https://docs.onap.org/projects/onap- |
multicloud- |
framework/en/latest/ |
index.html#master-index | Maintained | No Change | N/A | ||||||
MultilCoud | 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 | |||||||||
ONAP CLI | Release notes |
https://git.onap.org/ |
cli/tree/docs | https://docs.onap.org/projects/onap- |
cli/en/latest/index. |
html#master-index | 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/ |
Event Client Documentation Repository
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 |
release notes
API
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 |
https://git.onap.org/ |
dmaap/buscontroller/tree/docs/architecture | https://docs.onap.org/projects/onap-dmaap- |
buscontroller/en/latest/ |
architecture/ |
architecture.html |
Maintained |
No Change | N/A | |||||
DMAAP | Release Notes | https://git.onap.org/dmaap/ |
buscontroller/tree/docs/release-notes | https://docs.onap.org/projects/onap- |
dmaap-buscontroller/en/latest/ |
release-notes/release-notes.html |
Maintained | Minor |
Change | N/A | |||||
DMAAP | Data Controller API | https://git.onap.org/ |
dmaap/dbcapi/tree/docs | https://docs.onap.org/projects/onap- |
dmaap-dbcapi/en/latest/ |
MOD User guide
index.html#master-index | |||||||||
DMAAP | Data Router | https://git.onap. |
org/dmaap/ |
datarouter/tree/docs |
https://docs.onap.org/projects/onap- |
dmaap-datarouter/en/latest/ |
index.html#master-index | |||||||||
DMAAP | Message Router | https://git.onap.org/dmaap/ |
messagerouter/messageservice/tree/docs |
https://docs.onap.org/projects/onap- |
dmaap-messagerouter-messageservice/en/latest/ |
index.html#master-index | |||||||||
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 |
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 |
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 |
(ARC)
https://git.onap.org/externalapi/ |
nbi/tree/docs/ |
architecture/architecture.rst | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest |
/architecture/architecture.html | Maintained | No Change | N/A | ||||||
EXTAPI | Offered APIs |
https://git.onap.org/ |
externalapi/nbi/tree/docs/ |
offeredapis | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/ |
offeredapis/offeredapis.html | Maintained | Minor Update | N/A | ||||||
EXTAPI | Consumed APIs |
https://git.onap.org/ |
externalapi/nbi/tree/docs/ |
consumedapis | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/ |
https://git.onap.org/doc/log/docs/conf.py
consumedapis/consumedapis.html | Maintained | Minor Update | N/A | ||||||
EXTAPI | Installation |
(ARC)
https://git.onap.org/ |
externalapi/nbi/tree/docs/ |
architecture/architecture.rst | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/ |
installation/installation.html | Maintained | No Change | N/A | ||||||
EXTAPI | Developer Guide |
(ARC)
https://git.onap.org/externalapi/ |
nbi/tree/docs/ |
architecture/NBI_Developer_Guide.rst | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/ |
architecture/NBI_Developer_Guide.html |
Maintained | No Change |
N/A |
EXTAPI | Release Notes |
https://git.onap.org/externalapi/nbi/tree/docs/ |
releasenotes | https://docs.onap.org/projects/onap-externalapi-nbi/en/latest/ |
releasenotes/ |
releasenotes.html |
MSB |
Architecture |
https://git.onap.org/ |
msb/ |
apigateway/tree/docs/ |
platform/architecture.rst | https://docs.onap.org/projects/onap- |
msb- |
apigateway/en/latest/ |
platform/ |
architecture.html |
Maintained |
No Change | N/A |
MSB |
Offered APIs | https://git.onap.org/ |
msb/ |
apigateway/tree/docs/ |
platform/offeredapis.rst | https://docs.onap.org/projects/onap- |
msb- |
apigateway/en/latest/ |
platform/ |
offeredapis.html |
Maintained |
No Change | N/A |
MSB | Consumed APIs |
https://git.onap.org/ |
msb/ |
apigateway/tree/docs/ |
platform/ |
consumedapis.rst | https://docs.onap.org/projects/onap- |
msb- |
apigateway/en/latest/ |
platform/ |
consumedapis.html |
Maintained | No Change | N/A |
MSB | Installation |
https://git.onap.org/ |
msb/ |
apigateway/tree/docs/ |
platform/installation.rst | https://docs.onap.org/projects/onap- |
msb- |
apigateway/en/latest/ |
platform/installation.html |
Maintained | No Change | N/A |
MSB | Release Notes | https://git.onap.org/ |
msb/ |
apigateway/tree/docs/ |
release-notes.rst | https://docs.onap.org/projects/onap- |
msb- |
apigateway/en/latest/ |
release-notes.html | |||||||||
MSB |
Swagger API |
? | https://git.onap.org/msb/swagger-sdk/tree/docs | https://docs.onap.org/projects/onap-msb-swagger-sdk/en/latest/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 | |||||||||||||
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
...