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/AModelingModel SpecXu YangMaintainedMinor UpdateN/A


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

CLAMPRelease NoteMaintainedMajor
ModelingETSI CatalogYuanhong DengMaintainedMinor
UpdateN/A
(tick)


https://
docs
onap-doc.
onap
readthedocs.
org
io/
en
projects/
latest
onap-clamp/
submodules
en/
modeling
frankfurt/
etsicatalog.git/docs/index.htmlMultiCloudArchitecture
release-notes.html#release-notes
Release date need to be updated
ModelingModel SpecXu
Bin
YangMaintained
No Change
Minor UpdateN/A

https://docs.onap.org/en/
latest
frankfurt/submodules/
multicloud
modeling/
framework
modelspec.git/docs/
MultiCloud-Architecture
index.html
MultiCloudUser Guide

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/index.

html#multicloud-plugins-user-guides

html


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
APPCLCM API GuideTakamune ChoMaintainedMinor UpdateN/AAPPCClient Library GuideTakamune ChoMaintainedMinor UpdateN/AAPPCLogging GuideTakamune Cho

MaintainedNo ChangeN/A
APPC User GuideTakamune ChoMaintainedMinor UpdateN/AAPPCOAM API Guide


https://docs.onap.org/en/frankfurt/submodules/multicloud/framework.git/docs/MultiCloud-Architecture.html

No Frankfurt Branch !

Still API V1 vesion documented

MultiCloudUser Guide
Takamune Cho

MaintainedNo ChangeN/A
APPC CDT User GuideTakamune ChoMaintainedMinor UpdateN/APORTALRelease NotesLorraine Welch


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 API GuideTakamune ChoMaintainedMinor UpdateN/A
Did not attendDid not attendRC0


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

APPCClient Library GuideTakamune Cho
INTEGRATIONUser GuideMorgan Richomme
MaintainedMinor
update

see OOM Gating

and
UpdateN/A
INTEGRATIONCI GuideNewInitial publication


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://
wiki
docs.
opnfv
onap.org
/pages/viewpage.action?pageId=32015004
/en/frankfurt/submodules/appc.git/docs/APPC-Logging-Guide/APPC-Logging-Guide.html

APPC User GuideTakamune Cho
POLICYArchitecturePamela Dragosh
MaintainedMinor UpdateN/A

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

APPCOAM API GuideTakamune ChoMaintainedNo Change
POLICYOffered APIsMaintainedMinor Update
N/A

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

APPC CDT User GuideTakamune Cho
POLICYDevelopment GuidePamela Dragosh
MaintainedMinor UpdateN/A

https://docs.onap
-doc.readthedocs.io/projects/onap-policy-parent/en/latest/development/development.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)
EXTAPIArchitectureMaintainedNo ChangeN/A
https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
externalapi/nbi
integration.git/docs/
architecture/architecture
index.html?highlight=integration
EXTAPIOffered APIsAdrian OSullivanMaintainedMinor Update


INTEGRATIONCI GuideNewInitial publication

see OOM Gating

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

(error)(error)
N/A
https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
externalapi/nbi
integration.git/docs/
offeredapis/offeredapis
onap-integration-ci.html
EXTAPI


POLICY
Consumed APIs
Architecture
Adrian OSullivan

MaintainedMinor UpdateN/A

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


POLICY
Developer Guide
Offered APIs
Adrian OSullivan

MaintainedMinor UpdateN/A

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

POLICYDevelopment Guide
EXTAPIInstallationAdrian OSullivan

MaintainedMinor UpdateN/A

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


EXTAPIArchitecture
Weitao GaoVNFSDKUser GuideMaintainedNo ChangeN/A
MaintainedNo ChangeN/A
VNFSDKMarketplace/VTP APIMaintainedNo ChangeN/A


https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.htmlhttps://
docs
onap.
onap
readthedocs.
org
io/en/
latest
frankfurt/
guides/onap-developer/developing/index.html#service-orchestration
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 UpdateN
 SO API Seshu Kumar Mudiganti Maintained Minor Update N
/A

https://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
https://docs.onap.org/en/frankfurt/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html

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 OSullivanMaintainedMinor UpdateN/A

https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html
OOFArchitectureShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/AOOFHoming Specification GuideShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/AOOFAPIShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/AOOMSetup GuideMaintainedMinor updateN/AOOMRelease NotesMaintainedMinor updateN/AVF-COffered APIsYan YangMaintainedMinor updateN/A(tick)
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:/
VF-CInstallation GuideMaintainedMinor updateN/A(tick)https:/
/onap.readthedocs.io/en/
latest
frankfurt/submodules/
vfc
externalapi/
nfvo/lcm
nbi.git/docs/
platform/installation/index.html
architecture/NBI_Developer_Guide.htmlLink to http, no https - http still supported locally
EXTAPIInstallation
CCSDKCDS User GuideYuriy Malakov

MaintainedMinor
update
UpdateN/A
(tick)


https://
docs
onap.
onap
readthedocs.
org
io/en/frankfurt/submodules/
ccsdk
externalapi/
cds
nbi.git/docs/installation/
index
installation.html
CCSDKRelease NotesDan TimoneyMaintainedMinor updateN/A
(tick)
https://onap
-docCLIRelease Notes
.readthedocs.io
/projects/onap-ccsdk-distribution/en/frankfurt/release-notes.html
/en/frankfurt/submodules/externalapi/nbi.git/docs/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

VNFSDKArchitecture
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/vnf-test-platform.htmlhttps://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html
VNFSDKMarketplace/VTP APIMaintainedNo ChangeN/A

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
AAIOffered APIsMaintainedMinor UpdateN/AAAIAAI REST APIMaintainedMinor UpdateN/AAAIRelease NotesMaintainedMinor UpdateN/AMUSICArchitecture and UsageMaintainedMinor UpdateN/AN/AN/ASDNCOffered APIsDan TimoneyMaintainedMinor UpdateN/A(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/offeredapis.htmlSDNCRelease NotesDan TimoneyMaintainedMinor UpdateN/A(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.htmlDCAEArchitectureMaintainedMinor UpdateWIPDCAERelease NotesVijay Venkatesh KumarMaintainedMinor UpdateWIPDCAEOffered API'sVijay Venkatesh KumarMaintainedMinor Updatehttps://gerrit.onap.org/r/#/c/dcaegen2/+/100354/


https://docs.onap.org/en/
latest
frankfurt/submodules/
dcaegen2
so.git/docs/
sections
architecture/
offeredapis
architecture.html
DCAEConsumed API's


OOFArchitectureShankaranarayanan Puzhavakath Narayanan
Vijay Venkatesh Kumar
MaintainedMinor
Update
updateN/A

https://
docs
onap-doc.
onap
readthedocs.
org
io/
en/latest/submodules/dcaegen2.git/docs
projects/onap-optf-osdf/en/frankfurt/sections/
consumedapisWIP (
architecture.html
DCAE

MOD User guide

NewInitial publicationPlaceholder - DCAE MOD User Guide


OOFHoming Specification GuideShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

https://
gerrit
onap-doc.
onap
readthedocs.
org/r/c/dcaegen2/+/104620) DCAEDCAE Service Components
io/projects/onap-optf-has/en/frankfurt/sections/homingspecification.html

OOFAPIShankaranarayanan Puzhavakath Narayanan
Vijay Venkatesh Kumar
MaintainedMinor
UpdatePMSH -
updateN/A

https://
gerrit.
onap-doc.readthedocs.
org
io/
r/#/c/dcaegen2/+/98979/
projects/onap-optf-osdf/en/frankfurt/sections/offeredapis.html

OOMSetup GuideMaintainedMinor updateN/A


https://
docs.onap.org
onap-doc.readthedocs.io/projects/onap-oom/en/latest/
submodules/dcaegen2.git/docs/sections/services/pm-subscription-handler/index.htmlDCAEAcumos AdapterNewInitial publicationPlaceholder - Acumos DCAE IntegrationAs this is POC, documentation will be maintained on WIKI
index.html#master-index(tick)
OOMRelease NotesMaintainedMinor updateN/A




VF-COffered APIsYan YangMaintainedMinor updateN/A(tick)
https://onap.readthedocs.io
DMAAPArchitecture and UsageMaintainedNo ChangeDMAAPRelease NotesMaintainedMinor ChangeVIDRelease NotesIttay SternMaintained

Minor Update

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

Ittay Stern , automatically generated

Maintained

No Change

n/a(error)(error)
/platform/APIs/index.html

VF-C
VID
User Guide
Ittay Stern
Yan YangMaintained
No Change
Minor update
n
N/
a(error)
A
(error)
(tick)
https://
docs
onap.
onap
readthedocs.
org
io/en/frankfurt/submodules/vfc/
vid
nfvo/lcm.git/docs/
humaninterfaces
platform/installation/user-guide/ns-instantiate-guide.html
AAFWIKI


VF-CInstallation Guide
Jonathan Gathman

Maintained
Admin/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.
Minor 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 UsageMaintainedMinor UpdateN/AN/AN/Ahttps://onap-doc.readthedocs.io/projects/onap-music/en/frankfurt/release-notes.html
release date need to be updated
SDNCOffered APIsDan TimoneyMaintainedMinor UpdateN/A
(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/offeredapis.html

SDNCRelease NotesDan TimoneyMaintainedMinor UpdateN/A
(tick)https://onap-doc.readthedocs.io/projects/onap-sdnc-oam/en/frankfurt/release-notes.html
(tick)
DCAEArchitectureMaintainedMinor Update


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

DCAERelease NotesVijay Venkatesh KumarMaintainedMinor Update


https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/release-notes.html
(tick)
DCAEOffered API'sVijay Venkatesh KumarMaintainedMinor Updatehttps://gerrit.onap.org/r/#/c/dcaegen2/+/100354/

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

DCAEConsumed API'sMaintainedMinor Update


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

DCAE

MOD User guide

NewInitial publicationPlaceholder - DCAE MOD User Guide

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

DCAEDCAE Service ComponentsMaintainedMinor UpdatePMSH - https://gerrit.onap.org/r/#/c/dcaegen2/+/98979/

https://docs.onap.org/en/frankfurt/submodules/dcaegen2.git/docs/sections/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)https://docs.onap.org/en/frankfurt/submodules/vid.git/docs/release-notes.html
(tick)
VIDSwagger API

Ittay Stern , automatically generated

Maintained

No Change

n/a(error)(error)


VIDUser GuideIttay SternMaintained

No Change

n/a(error)(error)https://docs.onap.org/en/frankfurt/submodules/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/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 GuideMaintainedMinor UpdateN/A

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












SDCDeliveryMaintainedMinor updateN/A

https://docs.onap.org/en/frankfurt/submodules/sdc
Usecase-UIRelease Notesxu ranMaintainedMajor UpdateN/AUsecase-UIUser GuideMaintainedMinor UpdateN/A(tick)https://onap.readthedocs.io/en/latest/submodules/usecase-ui
.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

...