Versions Compared

Version Old Version 2 New Version 3
Changes made by

Andreas Geißler

Andreas Geißler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
Tracking Table


Project Name

Document TitleRST-FileRTD-Link

Document Owner

(name - use @ notation)

Current Document State (as of M1)

Choices:

  • New
  • Maintained

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 (tick) if attended)

Attended Doc Hackathon 2 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) 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-M4RC2

CLAMPArchitecturehttps://git.onap.org/clamp/tree/docshttps://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index

Gervais-Martial Ngueko

MaintainedMinor UpdateN/A




POLICYArchitecture

Ram Krishna Verma

MaintainedMinor UpdateN/A




POLICYOffered APIs

Ram Krishna Verma

MaintainedMinor UpdateN/A




POLICYDevelopment Guide

Ram Krishna Verma

MaintainedMinor UpdateN/A




HOLMESArchitecturehttps://git.onap.org/holmes/rule-management/tree/docs/platform/architecture.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/architecture.html

Guangrong Fu

MaintainedNo ChangeN/A




HOLMESOffered APIs

Guangrong Fu

HOLMESInstallation
https://git.onap.org/holmes/rule-management/tree/docs/platform/offeredapis.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/offeredapis.html

Guangrong Fu

MaintainedNo ChangeN/A




HOLMESConsumed APIs

Guangrong Fu

MaintainedMinor UpdateN/A
https://git.onap.org/holmes/rule-management/tree/docs/platform/consumedapis.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/consumedapis.html

Guangrong Fu

MaintainedMinor UpdateN/A
ModelingYuanhong Deng





HOLMES
Architecture
Installationhttps://git.onap.org/holmes/rule-management/tree/docs/platform/installation.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/platform/installation.html

Guangrong Fu

MaintainedMinor UpdateN/A
ModelingOOFArchitecture

krishna moorthy

MaintainedMinor UpdateN/AOOFOffered APIs

krishna moorthy

MaintainedMinor UpdateN/AOOFRelease Notes

krishna moorthy

MaintainedMinor UpdateN/AVFCOffered APIs
Yuanhong Deng
MaintainedMinor UpdateN/ASOArchitectureSeshu Kumar Mudiganti





HOLMES
Offered APIs
Yuanhong Deng
MaintainedMinor UpdateN/A
Release Noteshttps://git.onap.org/holmes/rule-management/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-holmes-rule-management/en/latest/release-notes.html








HOLMESEngine Managementhttps://git.onap.org/holmes/engine-management/tree/docshttps://docs.onap.org/projects/onap-holmes-engine-management/en/latest/index.html#master-index








ModelingArchitecture

Yuanhong Deng
MaintainedMinor UpdateN/A
SO





ModelingOffered APIs
Seshu Kumar Mudiganti


Yuanhong Deng
MaintainedMinor UpdateN/A
SOSeshu Kumar Mudiganti





OOF
Development Guide
Architecture

krishna moorthy

MaintainedMinor UpdateN/A
VIDittay





OOF
Release Notes
Offered APIs

krishna moorthy

MaintainedMinor UpdateN/A
VID





OOF
Swagger APIittay , automatically generated
Release Notes

krishna moorthy

Maintained
No Change
Minor UpdateN/A
VIDittay





VFC
User Guide
Offered APIs

Yuanhong Deng
Maintained
No Change
Minor UpdateN/A
Usecase UIxu ran





SO
Release Notesxu ran
Architecture

Seshu Kumar Mudiganti
MaintainedMinor UpdateN/A
Usecase UIUser Guide





SOOffered APIs

Seshu Kumar Mudiganti

MaintainedMinor UpdateN/A
Usecase UI





SO
Installation
Development Guide
xu ran


Seshu Kumar Mudiganti

Maintained
No Change
Minor UpdateN/A
SDC





VID
Architecture
Release Notes
ChrisC


ittay
MaintainedMinor UpdateN/A
SDCChrisC





VID
Release Notes
Swagger API

ittay , automatically generated

Maintained
Minor Update
No ChangeN/A
AAIOffered APIshttps://git.onap.org/aai/aai-common/tree/docs/platformhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/index.html#master-indexWilliam Reehil





VIDUser Guide

ittay
MaintainedNo ChangeN/A




Usecase UIRelease Notes

xu ran

MaintainedMinor Update
AAIAAI REST APIhttps://git.onap.org/aai/aai-common/tree/docs/AAI%20REST%20API%20Documentationhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/AAI%20REST%20API%20Documentation/AAIRESTAPI.html
William Reehil
N/A




Usecase UIUser Guide

xu ran

MaintainedMinor Update
AAIRelease Notes
N/A




Usecase UIInstallation Guide

xu ran

MaintainedNo ChangeN/A




SDCArchitecture

ChrisC
MaintainedMinor UpdateN/A




SDCRelease Notes

ChrisC

MaintainedMinor UpdateN/A




AAIOffered APIshttps://git.onap.org/aai/aai-common/tree/docs/
release-notes.rst
platformhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/
release-notes.html
index.html#master-index

William Reehil

MaintainedMinor Update





AAI
ESR GUI
AAI REST APIhttps://git.onap.org/aai/
esr
aai-
gui
common/tree/docs/AAI%20REST%20API%20Documentationhttps://docs.onap.org/projects/onap-aai-
esr
aai-
gui
common/en/latest/AAI%20REST%20API%20Documentation/
index.html#master-index?
AAIRESTAPI.html
William Reehil
MaintainedMinor Update





AAI
ESR Server
Release Noteshttps://git.onap.org/aai/
esr
aai-
server
common/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-aai-
esr
aai-
server
common/en/latest/
index.html#master-indexAAISparky BE Server
release-notes.html
William Reehil
MaintainedMinor Update





AAIESR GUIhttps://git.onap.org/aai/
sparky
esr-
be
gui/tree/docshttps://docs.onap.org/projects/onap-aai-
sparky
esr-
be
gui/en/latest/index.html#master-index?







AAI
Event Client Documentation Repository
ESR Serverhttps://
docs
git.onap.org/
projects
aai/
onap-aai-event-client/en/latest/index.html#master-index
esr-server/tree/docshttps://docs.onap.org/projects/onap-aai-
event
esr-
clientIntegrationTest Developer Guide

Marek Szwałkiewicz

NewInitial PublicationMultiCloudArchitecture

Bin Yang

MaintainedNo ChangeN/AMultiCloudRESP API

Bin Yang

MaintainedNo ChangeN/AMultiCloudUser Guild

Bin Yang

MaintainedNo ChangeN/AONAP CLIRelease notes

Former user (Deleted)

MaintainedMinot updatesN/AVNFSDK

release notes

API

Former user (Deleted)

MaintainedMinot updatesN/ADCAEArchitecture
server/en/latest/index.html#master-index
IntegrationRelease Notes

Morgan Richomme

MaintainedMinor UpdateIntegrationUser Guide including use case documentation

Morgan Richomme

MaintainedMinor Update









AAISparky BE Serverhttps://git.onap.org/aai/sparky-be/tree/docshttps://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-indexhttps://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-index








IntegrationRelease Notes
https://docs.onap.org/projects/onap-integration/en/latest/release-notes.html#release-notes

Morgan Richomme

MaintainedMinor Update





IntegrationUser Guide including use case documentation

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

Morgan Richomme

MaintainedMinor Update





IntegrationTest Developer Guide

Marek Szwałkiewicz

NewInitial Publication





MultiCloudArchitecture

Bin Yang

MaintainedNo ChangeN/A




MultiCloudRESP API

Bin Yang

MaintainedNo ChangeN/A




MultiCloudUser Guild

Bin Yang

MaintainedNo ChangeN/A




ONAP CLIRelease notes

Former user (Deleted)

MaintainedMinot updatesN/A




VNFSDK

release notes

API



Former user (Deleted)

MaintainedMinot updatesN/A




DCAEArchitecturehttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/architecture.html

Vijay Kumar

MaintainedMinor Update





DCAERelease Noteshttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.html
Vijay Kumar
MaintainedMinor Update





DCAEOffered API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/offeredapis.html
Vijay Kumar
MaintainedMinor Update





DCAEConsumed API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/consumedapis.html

Vijay Kumar

MaintainedMinor Update





DCAE

MOD User guide

https://git.onap.org/dcaegen2/tree/docs/sections/design-components/DCAE-MODhttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/index-onboarding.html

Vijay Kumar

MaintainedMinor Update





DCAEDCAE Service Componentshttps://git.onap.org/dcaegen2/tree/docs/sections/serviceshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html

Vijay Kumar

MaintainedMinor Update on existing components + new Guilin components





VVPVVP Documentation

steven stark
MaintainedMinor UpdateN/A




VNFRQTSProvider Docs

Trevor Lovett
MaintainedMinor Update





DMAAPArchitecture and Usagehttps://git.onap.org/dmaap/
dcaegen2
buscontroller/tree/docs/architecturehttps://docs.onap.org/projects/onap-dmaap-
dcaegen2
buscontroller/en/latest/
sections
architecture/architecture.html
Vijay Kumar
Mandar Sawant
Maintained
Minor UpdateDCAE
No ChangeN/A




DMAAPRelease Noteshttps://git.onap.org/dmaap/
dcaegen2
buscontroller/tree/docs/release-noteshttps://docs.onap.org/projects/onap-dmaap-
dcaegen2
buscontroller/en/latest/
sections
release-notes/release-notes.html
Vijay Kumar
Mandar Sawant
MaintainedMinor
UpdateDCAEOffered API's
ChangeN/A




DMAAPData Controller APIhttps://git.onap.org/
dcaegen2
dmaap/dbcapi/tree/docshttps://docs.onap.org/projects/onap-dmaap-
dcaegen2
dbcapi/en/latest/
sections/offeredapis.html
Vijay Kumar
MaintainedMinor UpdateDCAEConsumed API's
index.html#master-index








DMAAPData Routerhttps://git.onap.org/dmaap/
dcaegen2
datarouter/tree/docshttps://docs.onap.org/projects/onap-
dcaegen2
dmaap-datarouter/en/latest/
sections/consumedapis.html

Vijay Kumar

MaintainedMinor UpdateDCAE

MOD User guide

index.html#master-index








DMAAPMessage Routerhttps://git.onap.
org/dcaegen2
org/dmaap/messagerouter/messageservice/tree/docs
/sections/design-components/DCAE-MOD
https://docs.onap.org/projects/onap-dmaap-messagerouter-
dcaegen2
messageservice/en/latest/
sections/design-components/index-onboarding.htmlVijay Kumar
index.html#master-index








PORTALRelease Notes

Sunder Tattavarada

Maintained
Minor DCAE Service Components
Major UpdateN/A
DCAE





CCSDKCDS User Guidehttps://git.onap.org/
dcaegen2
ccsdk/cds/tree
/docs/sections
/
services
docshttps://docs.onap.org/projects/onap-ccsdk-
dcaegen2
cds/en/latest/
sections/services/serviceindex.html

Vijay Kumar

MaintainedMinor Update on existing components + new Guilin componentsVVPVVP Documentation
steven stark
MaintainedMinor UpdateN/AVNFRQTSProvider Docs
Trevor Lovett
MaintainedMinor UpdateDMAAPArchitecture and Usage
Mandar Sawant
MaintainedNo Change
index.html#master-index

Yuriy Malakov

MaintainedMinor updateN/A
DMAAP





CCSDKRelease Notes
Mandar Sawant
https://git.onap.org/ccsdk/distribution/tree/docshttps://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/release-notes.html
Dan Timoney
MaintainedMinor
ChangeCCSDKCDS User Guide
updateN/A
PORTALRelease Notes

Sunder Tattavarada

MaintainedMajor UpdateN/A





CCSDKCommon Controller Dashboardhttps://git.onap.org/ccsdk/dashboard/tree/docshttps://docs.onap.org/projects/onap-ccsdk-dashboard/en/latest/index.html#master-index








CCSDKCCSDK Platform Pluginshttps://git.onap.org/ccsdk/platform/
cds
plugins/tree/docshttps://docs.onap.org/projects/onap-ccsdk-platform-
cdsN/A
plugins/en/latest/index.html#master-index

Yuriy Malakov

MaintainedMinor update









CCSDKCCSDK
Release Notes
APPShttps://git.onap.org/ccsdk/
distribution
apps/tree/docshttps://docs.onap.org/projects/onap-ccsdk-apps/en/latest/index.html#master-index








CCSDKORANhttps://
docs
git.onap.org
/projects
/
onap-
ccsdk
-distribution
/
en
oran/
latest/release-notes.html
tree/docs









SDNCOffered APIs

Dan Timoney
MaintainedMinor Update





SDNCRelease Notes

Dan Timoney
MaintainedMinor
updateCommon Controller Dashboard
UpdateN/A
CCSDK





DOCRelease Noteshttps://git.onap.org/
ccsdk
doc/
dashboard/
tree/docs/release-notes.rsthttps://docs.onap.org
/projects/onap-ccsdk-dashboard
/en/latest/release/index.
html#master-indexCCSDKCCSDK Platform Plugins
html
Sofia Wallin
MaintainedMinor UpdateN/A




DOCLanding pagehttps://git.onap.org/
ccsdk/platform/plugins
doc/tree/docshttps://docs.onap.org/
projects/onap-ccsdk-platform-plugins/
en/latest/index.
html#master-indexCCSDKCCSDK APPS
html
Sofia Wallin
MaintainedMinor UpdateN/A




DOCComposite release notehttps://git.onap.org/
ccsdk/apps
doc/tree/docs/releasehttps://docs.onap.org
/projects/onap-ccsdk-apps
/en/latest/release/
index
releaserepos.
html#master-indexCCSDKORANhttps://git.onap.org/ccsdk/oran/tree/docsSDNCOffered APIs
Dan Timoney
MaintainedMinor UpdateSDNCRelease NotesDan Timoney
html#doc-releaserepos

Sofia Wallin

MaintainedMinor UpdateN/A




DOC
Release Notes
ONAP User Guideshttps://git.onap.org/doc/tree/docs/guides/
release
onap-
notes.rst
userhttps://docs.onap.org/en/latest/guides/
release
onap-user/index.html
Sofia Wallin
MaintainedMinor UpdateN/A




DOC
Landing page
ONAP Operation Guideshttps://git.onap.org/doc/tree/docs/guides/onap-operatorhttps://docs.onap.org/en/latest/guides/onap-operator/index.html
Sofia Wallin
MaintainedMinor UpdateN/A




DOC
Composite release note
RST Templateshttps://git.onap.org/doc
/tree/docs/releasehttps://docs.onap.org/en/latest/release/releaserepos.html#doc-releasereposN/A
/tree/docs/templates
Sofia Wallin
MaintainedMinor Update








DOCDOC
ONAP User Guides
Developer Guidehttps://git.onap.org/doc/tree/docs/guides/onap
-user
-developer/how-to-use-docshttps://docs.onap.org/en/latest/guides/onap
-userDOCONAP Operation Guides
-developer/how-to-use-docs/index.html
Sofia Wallin
MaintainedMinor UpdateN/A








DOC
(ARC)		API Referencehttps://git.onap.org/doc/tree/docs/guides/onap-
operator
developer/apirefhttps://docs.onap.org/en/latest/guides/onap-
operatorN/A
developer/apiref/index.html
Sofia Wallin
MaintainedMinor Update
? Chaker Al-Hakim








DOC
RST Templates
ONAP Tutorialshttps://git.onap.org/doc/tree/docs/
templatesSofia WallinDOCDOC Developer Guidehttps://git.onap.org/doc/tree/docs/
guides/onap
-developer/how-to-use-docs
-developer/tutorialshttps://docs.onap.org/en/latest/guides/onap-developer/
how-to-use-docs
tutorials/index.html
Sofia WallinAPI Reference
? 







DOC
(ARC)
ONAP Component Document Indexhttps://git.onap.org/doc/tree/docs/guides/onap-developer/
apiref
developing

https://docs.onap.org/en/latest/guides/onap-developer/

apirefDOCONAP Tutorials

developing/index.html

? Chaker Al-Hakim

https://git.onap.org/doc/log/docs/conf.py

Sofia Wallin








DOC
(ARC)		ONAP Architecturehttps://git.onap.org/doc/tree/docs/guides/onap-developer/
tutorials
architecturehttps://docs.onap.org/en/latest/guides/onap-developer/
tutorials
architecture/index.html
? Chaker Al-Hakim








DOC
(ARC)		ONAP
Component Document Index
Overviewhttps://git.onap.org/doc/tree/docs/guides/
onap-developer/developing
overviewhttps://docs.onap.org/en/latest/guides/
onap-developer/developingDOC
(ARC)ONAP
overview/index.html

https://git.onap.org/doc/log/docs/conf.py

Sofia Wallin
? 







OOMSetup Guide

Sylvain Desbureaux

MaintainedMinor UpdateN/A




OOMRelease Notes

Sylvain Desbureaux

MaintainedMinor UpdateN/A




EXTAPIArchitecturehttps://git.onap.org/externalapi/
doc
nbi/tree/docs/
guides
architecture/
onap-developer/
architecture.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/
guides
architecture/
onap-developer/
architecture
/indexDOC
(ARC)ONAP Overview
.html
? Chaker Al-Hakim
Adrian OSullivan
MaintainedNo ChangeN/A




EXTAPIOffered APIshttps://git.onap.org/externalapi/
doc
nbi/tree/docs/
guides/overview
offeredapishttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/
guides
offeredapis/
overview/index.html? OOMSetup Guide

Sylvain Desbureaux

MaintainedMinor UpdateN/AOOMRelease NotesSylvain DesbureauxOffered APIs
offeredapis.html
Adrian OSullivan
MaintainedMinor UpdateN/A




EXTAPI
Architecture
Adrian OSullivan
MaintainedNo ChangeN/AEXTAPI
Consumed APIshttps://git.onap.org/externalapi/nbi/tree/docs/consumedapishttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/consumedapis/consumedapis.html
Adrian OSullivan
MaintainedMinor UpdateN/A




EXTAPI
Consumed APIs
Installationhttps://git.onap.org/externalapi/nbi/tree/docs/architecture/architecture.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/installation/installation.html

Adrian OSullivan

Maintained
Minor Update
No ChangeN/A
EXTAPIInstallationN/A





EXTAPIDeveloper Guidehttps://git.onap.org/externalapi/nbi/tree/docs/architecture/NBI_Developer_Guide.rsthttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/architecture/NBI_Developer_Guide.html

Adrian OSullivan

MaintainedNo ChangeN/A




EXTAPI
Developer Guide

Adrian OSullivan

MaintainedNo Change
Release Noteshttps://git.onap.org/externalapi/nbi/tree/docs/releasenoteshttps://docs.onap.org/projects/onap-externalapi-nbi/en/latest/releasenotes/releasenotes.html








MSBArchitecture

Former user (Deleted)
MaintainedNo ChangeN/A




MSBOffered APIs

Former user (Deleted)
MaintainedNo ChangeN/A




MSBConsumed APIs

Former user (Deleted)
MaintainedNo ChangeN/A




MSBInstallation

Former user (Deleted)
Maintained No ChangeN/A




APPCAPPC Deploymenthttps://git.onap.org/appc/deployment/tree/docshttps://docs.onap.org/projects/onap-appc-deployment/en/latest/index.html#master-index








APPCAPPC Documentationhttps://git.onap.org/appc/tree/docshttps://docs.onap.org/projects/onap-appc/en/latest/index.html#master-index








AAFApplication Authorization Frameworkhttps://git.onap.org/aaf/authz/tree/docshttps://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-index








AAFSecret Management Servicehttps://git.onap.org/aaf/sms/tree/docshttps://docs.onap.org/projects/onap-aaf-sms/en/latest/index.html#master-index








CLICommand Line interfacehttps://git.onap.org/cli/tree/docshttps://docs.onap.org/projects/onap-cli/en/latest/index.html#master-index























































































Procedure

M1

  1. Find JIRA task attached to M1 Epic for your project, if you haven't already done so.
  2. 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
  3. Update status of JIRA task as Done

...