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 | |||||||
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/ |
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 |
Event Client Documentation Repository
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://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 |
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 |
API
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 | Not Linked in DOC | Eric Multanen | ||||||||
MultiCloud | Azure | https:// |
git.onap.org/ |
multicloud/ |
azure/ |
tree/docs | ||||||||||
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 | https://git.onap.org/vnfsdk/ |
model/tree/docs | https://docs.onap.org/projects/onap-vnfsdk- |
model/en/latest/ |
index.html#master-index | 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 |
https://git.onap.org/ |
vvp/ |
documentation/tree/docs | Not linked in DOCs ... | Maintained | Minor Update | N/A | ||||||
VNFRQTS | Provider Docs | https://docs.onap.org/en/ |
latest/guides/onap- |
provider/index. |
html | Maintained | Minor Update | |||||||
VNFRQTS | VNF Guidelines |
https://git.onap.org/ |
vnfrqts/ |
guidelines/ |
tree/docs | https://docs.onap.org/projects/onap- |
vnfrqts- |
guidelines/en/latest/index.html#master-index |
VNFRQTS | VNF/PNF Requirement |
https://git.onap.org/ |
vnfrqts/requirements/tree/docs | https://docs.onap.org/projects/onap-vnfrqts- |
requirements/en/latest/ |
index.html#master-index | |||||||||
VNFRQTS | VNF Testcases | https://git.onap.org/ |
vnfrqts/ |
testcases/tree/docs | https://docs.onap.org/projects/onap- |
vnfrqts- |
testcases/en/latest/index.html#master-index |
VNFRQTS | VNF Usecases |
https://git.onap.org/ |
vnfrqts/ |
usecases/tree/docs | https://docs.onap.org/projects/onap- |
vnfrqts- |
usecases/en/latest/ |
index.html#master-index | |||||||||
VNFRQTS | Release notes |
https://git.onap.org/ |
vnfrqts/ |
requirements/tree/docs | https://docs.onap.org/projects/onap- |
vnfrqts- |
requirements/en/latest/ |
release-notes. |
html#release- |
notes |
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/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 | https://git.onap.org/ |
portal/tree/docs |
https://docs.onap.org/projects/onap-portal/en/latest/release |
-notes.html |
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 | ||||||||||
CCSDK | SDN-R |
(ARC)
https://git.onap.org/ |
ccsdk/features/tree/docs |
https://docs.onap.org/ |
projects/ |
onap-ccsdk- |
features/en/ |
latest/index. |
Architecture SC ? Chaker Al-Hakim
html#master-index | |||||||||
SDNC | Offered APIs |
https://git.onap.org/ |
sdnc/oam/tree/docs |
https://docs.onap.org/ |
projects/onap-sdnc- |
oam/en/ |
latest/ |
offeredapis.html |
Maintained | Minor Update | ||||||||
SDNC | Release Notes |
https://git.onap.org/ |
sdnc/oam/tree/docs | https://docs.onap.org/ |
projects/onap |
-sdnc-oam/en/latest/release-notes.html | Maintained | Minor Update | N/A | ||||||
DOC | Release Notes | https://git.onap.org/doc/tree/docs/release-notes.rst | https://docs.onap.org/en/latest/ |
/oom/platform/cert-service/tree/docs/ |
(ARC)
sections/release-notes.rst | Not linked !! | ? | ||||||||
OOM | Offline Installer |
https://git.onap.org/oom/ |
offline-installer/tree/docs |
https://docs.onap.org/en/latest/guides/onap- |
operator/ |
settingup/index.html |
? |
(ARC)
EXTAPI | Architecture |
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/consumedapis/ |
consumedapis.html |
Maintained | Minor Update | N |
/A | |||||
EXTAPI | Installation |
https://git.onap.org/ |
externalapi/nbi/tree/docs/architecture/architecture.rst | https://docs.onap.org/projects/onap- |
externalapi-nbi/en/latest/ |
Release-Notes
installation/installation.html | Maintained | No Change | N/A | ||||||
EXTAPI | Developer Guide |
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 | |||||||||
MSB | Java SDK |
https://git.onap.org/msb/ |
java-sdk/tree/docs |
MSB | Discovery | https:// |
git.onap.org |
/ |
msb |
/discovery/tree/docs | ||||||||||
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 |
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 |
https://git.onap.org/ |
music/tree/docs | https://docs.onap.org/projects/onap- |
music/en/latest/index.html#master-index |
MUSIC | Distributed KV Store |
https://git.onap.org |
/music/distributed-kv-store/tree/docs | https://docs.onap.org/projects/onap-music-distributed- |
kv- |
store/en/latest/index.html#master-index |
SEC SubCom | ONAP Security Advisories |
?? | Oparent CIA |
https://git.onap.org/ |
oparent/cia/tree/docs | ||||||||||
POMBA | Pomba | https:// |
git.onap.org/logging-analytics/ |
pomba/ |
pomba- |
audit-common/tree/docs |
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
...