Versions Compared

Key

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

Table of Contents

Tracking Table

Project Name

Document Title

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 March 11

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Attended Doc Hackathon 2 on March 25

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) if attended)

Link to Final Documentation in ReadTheDocs (stable/frankfurt 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-M4RC0RC2
CLAMPArchitectureMaintainedMinor UpdateN/A

https://docs.onap.org/en/frankfurt/guides/onap-developer/architecture/onap-architecture.html#closed-control-loop-automation

CLAMPUser GuideMaintainedMinor UpdateN/A
CLAMPRelease NoteMaintainedMajor UpdateN/A


https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/user-guide.html

CLAMPRelease NoteMaintainedMajor
ModelingModel SpecXu YangMaintainedMinor
UpdateN/A

https://
docs
onap-doc.
onap
readthedocs.
org
io/
en
projects/
latest
onap-clamp/
submodules
en/
modeling
frankfurt/
modelspec.git/docs/index.html
release-notes.html#release-notes
Release date need to be updated
Modeling
ETSI Catalog
Model SpecXu Yang
Yuanhong Deng
MaintainedMinor UpdateN/A
(tick)


https://docs.onap.org/en/
latest
frankfurt/submodules/modeling/
etsicatalog
modelspec.git/docs/index.html
MultiCloudArchitecture

Still reference to Dublin

No Frankfurt branch

ModelingETSI CatalogYuanhong Deng
Bin Yang
Maintained
No Change
Minor UpdateN/A(tick)

https://docs.onap.org/en/

latest

frankfurt/submodules/

multicloud

modeling/

framework

etsicatalog.git/docs/

MultiCloud-Architecture

index.html

MultiCloud

OK, with RST file in gerrit, but pb  with Frankfurt link:

https://docs.onap.org/en/frankfurt/submodules/modeling/etsicatalog.git/docs/index.html


MultiCloudArchitecture
User Guide
MaintainedNo ChangeN/A

https://docs.onap.org/en/
latest
frankfurt/submodules/multicloud/framework.git/docs/
index.html#multicloud-plugins-user-guides
MultiCloud-Architecture.html

No Frankfurt Branch !

Still API V1 vesion documented

MultiCloudUser Guide
APPCLCM API GuideTakamune ChoMaintainedMinor UpdateN/AAPPCClient Library GuideTakamune ChoMaintainedMinor UpdateN/AAPPCLogging GuideTakamune Cho

MaintainedNo ChangeN/A
APPC User GuideTakamune ChoMaintainedMinor UpdateN/AAPPC


https://docs.onap.org/en/frankfurt/submodules/multicloud/framework.git/docs/index.html#multicloud-plugins-user-guides

No Frankfurt Branch !

Still API V1 vesion documented

APPCLCM
OAM
API GuideTakamune ChoMaintained
No Change
Minor UpdateN/A
APPC CDT User Guide


https://onap-doc.readthedocs.io/projects/onap-appc/en/frankfurt/APPC-LCM-API-Guide/APPC-LCM-API-Guide.html

APPCClient Library GuideTakamune ChoMaintainedMinor UpdateN/A
PORTALRelease NotesLorraine WelchMaintainedMinor UpdateN/ADid not attendDid not attendRC0INTEGRATIONUser GuideMaintainedMinor updateN/AINTEGRATIONCI GuideNewInitial publication

see OOM Gating

and https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004



https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-Client-Library-Guide/APPC-Client-Library-Guide.html



APPCLogging GuideTakamune ChoMaintainedNo ChangeN/A

https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-Logging-Guide/APPC-Logging-Guide.html

APPC User GuideTakamune ChoMaintainedMinor UpdateN/A

https://docs.onap.org/en/frankfurt/submodules/appc.git/docs/APPC-User-Guide/APPC-User-Guide.html

APPCOAM API GuideTakamune ChoMaintainedNo Change
POLICYArchitectureMaintainedMinor Update
N/A

https://docs.onap
-doc
.
readthedocs.io
org/
projects/onap-policy-parent/en/latest/architecture/architecture.html
en/frankfurt/submodules/appc.git/docs/APPC-OAM-API-Guide/APPC-OAM-API-Guide.html

APPC CDT User GuideTakamune Cho
POLICYOffered APIsPamela Dragosh
MaintainedMinor UpdateN/A

https://docs.onap
-doc.readthedocs.io/projects/onap-policy-parent/en/latest/offeredapis.html
.org/en/frankfurt/submodules/appc.git/docs/APPC-CTD-Guide/APPC-CDT-Guide.html

PORTALRelease NotesLorraine WelchMaintainedMinor UpdateN/A(error)(error)RC0

INTEGRATIONUser GuideMaintainedMinor updateN/A(error)(error)https://docs.onap.org/en/frankfurt/submodules/integration.git/docs/index.html?highlight=integration

INTEGRATIONCI GuideNewInitial publication

see OOM Gating

and https://wiki.opnfv.org/pages/viewpage.action?pageId=32015004

(error)(error)https://docs.onap.org/en/frankfurt/submodules/integration.git/docs/onap-integration-ci.html


POLICYArchitecture
POLICYDevelopment GuideMaintainedMinor UpdateN/Ahttps://onap-doc.readthedocs.io/projects/onap-policy-parent/en/latest/development/development.htmlEXTAPIArchitectureMaintainedNo ChangeN/Ahttps://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/architecture/architecture.htmlEXTAPIOffered APIsAdrian OSullivan

MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/
en/latest/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis
projects/onap-policy-parent/en/frankfurt/architecture/architecture.html
EXTAPI


POLICY
Consumed
Offered APIs
Adrian OSullivan
MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/
en/latest/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.htmlEXTAPIDeveloper Guide
projects/onap-policy-parent/en/frankfurt/offeredapis.html

POLICYDevelopment Guide
Adrian OSullivan

MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/
latest
frankfurt/
submodules
development/
externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html
development.html

EXTAPIArchitecture
EXTAPIInstallation
Maintained
Minor Update
No ChangeN/A

https://onap.readthedocs.io/en/
latest
frankfurt/submodules/externalapi/nbi.git/docs/
installation
architecture/
installation
architecture.html
VNFSDKArchitectureMaintainedNo ChangeN/AVNFSDKMarketplace/VTP APIMaintainedNo ChangeN/A
https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.html

nbicallflow.pdf

to be updated

Adrian OSullivan : API flow/examples now covered in swagger markup examples in offeredapis 

EXTAPIOffered APIsAdrian OSullivanMaintainedMinor Update
VNFSDKUser GuideMaintainedNo Change
N/A

https://docs.onap.org/en/
latest/guides/onap-developer/developing/index.html#service-orchestration SO API Seshu Kumar Mudiganti Maintained Minor Update N/A
frankfurt/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.htmlhttps://docs.onap.org/en/
latest
frankfurt/submodules/externalapi/
so
nbi.git/docs/
architecture
offeredapis/
architecture
offeredapis.html
 SO Architecture Seshu Kumar Mudiganti Maintained Minor Update N/A

Question: API version still v4 ? Adrian OSullivan : Yes, no major API change, so still v4

Still reference to El Alto Adrian OSullivan : cherry picked /updated on frankfurt branch

EXTAPIConsumed APIsAdrian OSullivan
OOFArchitectureShankaranarayanan Puzhavakath Narayanan
MaintainedMinor
updateOOFAPIShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/AOOMSetup GuideMaintainedMinor updateN/AOOMRelease NotesMaintainedMinor updateN/AVF-COffered APIsYan YangMaintainedMinor updateN/A(tick)
UpdateN/A
OOFHoming Specification GuideShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A


https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html
https://onap.readthedocs.io/en/
latest
frankfurt/submodules/
vfc
externalapi/
nfvo/lcm
nbi.git/docs/
platform
consumedapis/
APIs/index
consumedapis.html
VF-CUser Guide

Check API vesrions used for other componntes: AAI, SO, DMAAP

Adrian OSullivan : checked and valid

EXTAPIDeveloper Guide
Yan Yang

MaintainedMinor
update
UpdateN/A
(tick)


https://onap.readthedocs.io/en/
latest
frankfurt/submodules/
vfc
externalapi/
nfvo/lcm
nbi.git/docs/
platform/installation/user-guide/ns-instantiate-guide.html
architecture/NBI_Developer_Guide.htmlhttps://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.htmlLink to http, no https - http still supported locally
EXTAPIInstallationMaintainedMinor Update
VF-CInstallation GuideMaintainedMinor update
N/A
(tick)


https://onap.readthedocs.io/en/
latest
frankfurt/submodules/
vfc
externalapi/
nfvo/lcm
nbi.git/docs/
platform
installation/installation
/index
.html
CCSDKCDS User GuideMaintainedMinor update
N/A(tick)
https://
docs
onap.
onap
readthedocs.
org
io/en/frankfurt/submodules/
ccsdk
externalapi/
cds
nbi.git/docs/
index.htmlCCSDKRelease NotesDan TimoneyMaintained
installation/installation.html

Still http Adrian OSullivan when running and testing local docker it is http, https only for OOM install

v4 ok ? Adrian OSullivan Yes

VNFSDKArchitectureMaintainedNo Change
Minor update
N/A
(tick)


https://docs.onap
-doc
.
readthedocs.io
org/
projects/onap-ccsdk-distribution/en/frankfurt/release-notes.html
en/latest/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.htmlhttps://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html
VNFSDKMarketplace/VTP API
CLIRelease Notes
Maintained
Minor Update
No ChangeN/A
VVPVNF Validation DocumentationMaintainedMinor updateNANANAVNF Validation DocumentationVNFRQTSVNF and PNF Requirements and GuidelinesMaintainedMinor UpdateNANANAVNF and PNF Requirements and Guidelines


https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/files/marketplace-overview.htmlhttps://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/marketplace-overview.html
VNFSDKUser GuideMaintainedNo ChangeN/A

https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/index.html#user-guideshttps://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/index.html#user-guides 
 SO API Seshu Kumar Mudiganti Maintained Minor Update N/A

https://onap-doc.readthedocs.io/projects/onap-so/en/frankfurt/api/offered_consumed_apis.html



 SO Architecture Seshu Kumar Mudiganti Maintained Minor Update N/A

https://docs.onap.org/en/frankfurt/submodules/so.git/docs/architecture/architecture.html

OOFArchitectureShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

https://onap-doc.readthedocs.io/projects/onap-optf-osdf/en/frankfurt/sections/architecture.html

OOFHoming Specification GuideShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

https://onap-doc.readthedocs.io/projects/onap-optf-has/en/frankfurt/sections/homingspecification.html

OOFAPIShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

https://onap-doc.readthedocs.io/projects/onap-optf-osdf/en/frankfurt/sections/offeredapis.html

OOMSetup GuideMaintainedMinor updateN/A


https://onap-doc.readthedocs.io/projects/onap-oom/en/latest/index.html#master-index(tick)
OOMRelease NotesMaintainedMinor updateN/A




VF-COffered APIsYan YangMaintainedMinor updateN/A(tick)
https://onap.readthedocs.io/en/frankfurt/submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.html

VF-CUser GuideYan YangMaintainedMinor updateN/A(tick)
https://onap.readthedocs.io/en/frankfurt/submodules/vfc/nfvo/lcm.git/docs/platform/installation/user-guide/ns-instantiate-guide.html

VF-CInstallation GuideMaintainedMinor updateN/A(tick)
https://onap.readthedocs.io/en/frankfurt/submodules/vfc/nfvo/lcm.git/docs/platform/installation/index.html

CCSDKCDS User GuideMaintainedMinor updateN/A
(tick)https://docs.onap.org/en/frankfurt/submodules/ccsdk/cds.git/docs/index.html

CCSDKRelease NotesDan TimoneyMaintainedMinor updateN/A
(tick)https://onap-doc.readthedocs.io/projects/onap-ccsdk-distribution/en/frankfurt/release-notes.html
(tick)
CLIRelease NotesMaintainedMinor UpdateN/A




VVPVNF Validation DocumentationMaintainedMinor updateNANANAVNF Validation Documentation

VNFRQTSVNF and PNF Requirements and GuidelinesMaintainedMinor UpdateNANANAVNF and PNF Requirements and Guidelines

AAIOffered APIsMaintainedMinor UpdateN/A(error)(error)https://onap-doc.readthedocs.io/projects/onap-aai-aai-common/en/frankfurt/platform/offeredapis.html

AAIAAI REST APIMaintainedMinor UpdateN/A(error)(error)AAI REST API Documentation - Frankfurt

AAIRelease NotesMaintainedMinor UpdateN/A(error)(error)https://onap-doc.readthedocs.io/projects/onap-aai-aai-common/en/frankfurt/release-notes.html

MUSICArchitecture and Usage
AAIOffered APIsJames Forsyth

MaintainedMinor UpdateN/A
AAIAAI REST APIMaintainedMinor UpdateN/A
N/AN/Ahttps://onap-doc.readthedocs.io/projects/onap-music/en/frankfurt/release-notes.html
release date need to be updated
SDNCOffered APIsDan Timoney
AAIRelease NotesJames Forsyth
MaintainedMinor UpdateN/A
MUSICArchitecture and UsageMaintainedMinor UpdateN/AN/AN/ASDNC

(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/offeredapis.html

SDNCRelease Notes
Offered APIs
Dan TimoneyMaintainedMinor UpdateN/A
(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/
offeredapis
release-notes.html
(tick)
SDNC
DCAE
Release Notes
Architecture
Dan Timoney

MaintainedMinor Update
N/A



https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/architecture.html

DCAERelease NotesVijay Venkatesh KumarMaintainedMinor Update
(tick)



https://docs.onap
-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt
.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/release-notes.html
(tick)
DCAE
Architecture
Offered API'sVijay Venkatesh
KumarMaintainedMinor Update
KumarMaintainedMinor Updatehttps://gerrit.onap.org/r/#/c/dcaegen2/+/100354/

https://docs.onap.org/en/
latest
frankfurt/submodules/dcaegen2.git/docs/sections/
architecture
offeredapis.html

DCAE
Release Notes
Consumed API'sMaintainedMinor Update


https://docs.onap.org/en/
latest
frankfurt/submodules/dcaegen2.git/docs/sections/
release-notes
consumedapis.html

DCAE
Offered API's

MOD User guide

Maintained
New
Minor Updatehttps://gerrit.onap.org/r/#/c/dcaegen2/+/100354/
Initial publicationPlaceholder - DCAE MOD User Guide

https://docs.onap.org/en/
latest
frankfurt/submodules/dcaegen2.git/docs/sections
/offeredapis
/design-components/DCAE-MOD/DCAE-MOD-User-Guide.html

DCAE
Consumed API's
DCAE Service Components
Maintained

MaintainedMinor UpdatePMSH - https://gerrit.onap.org/r/#/c/dcaegen2/+/98979/
Minor Update


https://docs.onap.org/en/

latest

frankfurt/submodules/dcaegen2.git/docs/sections

/consumedapis.htmlDCAE

MOD User guide

NewInitial publicationPlaceholder - DCAE MOD User Guidehttps://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/design-components/DCAE-MOD/DCAE-MOD-User-Guide.htmlDCAEDCAE Service ComponentsMaintainedMinor Update

/services/pm-subscription-handler/index.html



DCAEAcumos AdapterNewInitial publicationPlaceholder - Acumos DCAE Integration

As this is POC, documentation will be maintained on WIKI



DMAAPArchitecture and UsageMaintainedNo Change


Data Router

Bus Controller

Message Router



DMAAPRelease NotesMaintainedMinor Change


Data Router

Bus Controller

Message Router



VIDRelease NotesIttay SternMaintained

Minor Update

n/a(error)(error)
PMSH - https://gerrit.onap.org/r/#/c/dcaegen2/+/98979/
https://docs.onap.org/en/
latest
frankfurt/submodules/
dcaegen2
vid.git/docs
/sections/services/pm-subscription-handler/index.htmlDCAEAcumos AdapterNewInitial publicationPlaceholder - Acumos DCAE Integration

As this is POC, documentation will be maintained on WIKI

Acumos Adapter Installation

Acumos DCAE Integration

DMAAPArchitecture and Usage
/release-notes.html
(tick)
VIDSwagger API

Ittay Stern , automatically generated

Maintained

No Change

DMAAPRelease NotesMaintainedMinor Change
n/a(error)(error)


VIDUser Guide
VIDRelease Notes
Ittay SternMaintained
Minor Update

No Change

n/a(error)(error)https://docs.onap.org/en/frankfurt/submodules/
/docs.onap.org/en/frankfurt/submodules/vid.git/docs/release-notes.htmlVIDSwagger API

Ittay Stern , automatically generated

Maintained

No Change

n/a(error)(error)VIDUser GuideIttay SternMaintained

No Change

n/a(error)(error)
vid.git/docs/humaninterfaces.html

AAFWIKIMaintainedAdmin/ReleaseApplication Authorization Framework (AAF) Documentation




AAFMain DocsMaintainedImprove (link to Swagger?)/Add new Feature info.AAF Read-the-Docs

AAF Read-the-Docs

AAFAPI DocsMaintainedMove content to Swagger in Frankfurt

AAF API Docs has always been a code-generated part of the AAF GUI. Image Added

The intention for Frankfurt is to take the Code Generation element existing, and generate Swagger.



See any AAF GUI.

Usecase-UIRelease Notesxu ranMaintainedMajor UpdateN/A

https://docs.onap.org/en

/frankfurt/submodules/vid.git/docs/humaninterfaces.htmlAAFWIKIMaintainedAdmin/ReleaseApplication Authorization Framework DocumentationAAFMain DocsMaintainedImprove (link to Swagger?)/Add new Feature info.AAF Read-the-DocsAAF Read-the-DocsAAFAPI DocsMaintainedMove content to Swagger in Frankfurt

AAF API Docs has always been a code-generated part of the AAF GUI. Image Removed

The intention for Frankfurt is to take the Code Generation element existing, and generate Swagger.

See any AAF GUI.

/frankfurt/submodules/usecase-ui.git/docs/release-notes.html



Usecase-UIUser GuideMaintainedMinor UpdateN/A
(tick)https://docs.onap.org/en/frankfurt/submodules/usecase-ui.git/docs/platform/installation/user-guide/index.html

Usecase-UIInstallation Guide
Usecase-UIRelease Notes
Maintained
Major
Minor UpdateN/A
Usecase-UIUser Guide


https://docs.onap.org/en/frankfurt/submodules/usecase-ui.git/docs/platform/installation/installation/index.html












SDCDelivery
xu ran

MaintainedMinor
Update
updateN/A
(tick)


https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
usecase-ui
sdc.git/docs/index.html
Usecase-UIInstallation Guide


HolmesRelease Notes
xu ran

MaintainedMinor
Update
updateN/A
SDC





Holmes
Release notes
User GuideGuangrong Fu
Ofir Sonsino
Maintained
Major updateN/Ahttps://onap.readthedocs.io/en/latest/submodules/sdc.git/docs/index.html
Minor updateN/A




HolmesArchitectureMaintainedMinor updateN/A




MSBRelease NotesHuabing Zhao
SDCDeliveryOfir Sonsino
MaintainedMinor updateN/A

https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/msb/
sdc
apigateway.git/docs/
index.htmlHolmesRelease NotesMaintainedMinor updateN/A
release-notes.html
(tick)
MSB
Holmes
User Guide
Guangrong Fu
Huabing ZhaoMaintainedMinor updateN/A
HolmesArchitectureMaintainedMinor updateN/A


https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/platform/user-guide.html
(tick)
MSBArchitecture
MSBRelease NotesHuabing ZhaoMaintainedMinor updateN/AMSBUser Guide
Huabing ZhaoMaintainedMinor updateN/A
MSBArchitectureHuabing ZhaoMaintainedMinor updateN/A


https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/platform/architecture.html

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

...