Versions Compared

Old Version 72

changes.mady.by.user xu ran

Saved on

compared with

New Version Current

changes.mady.by.user Mandar Sawant

Saved on

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
CLAMPArchitecture

Gervais-Martial Ngueko

MaintainedMinor UpdateN/A

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

CLAMPUser Guide

Gervais-Martial Ngueko

MaintainedMinor UpdateN/A

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

CLAMPRelease Note

Gervais-Martial Ngueko

MaintainedMajor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/release-notes.html#release-notes
Release date need to be updated
ModelingModel SpecXu YangMaintainedMinor UpdateN/A

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

Still reference to Dublin

No Frankfurt branch

ModelingETSI CatalogYuanhong DengMaintainedMinor UpdateN/A(tick)

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

latestN/A

frankfurt/submodules/modeling/etsicatalog.git/docs/index.html

MultiCloudArchitecture

Bin Yang

MaintainedNo Change

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

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

latest

frankfurt/submodules/

multicloud

modeling/

framework

etsicatalog.git/docs/

MultiCloud-Architecture

index.html


MultiCloud
User Guide
Architecture

Bin Yang

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

Bin Yang

MaintainedNo ChangeN/A

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
APPCLCM API GuideTakamune ChoMaintainedMinor UpdateN/AAPPCClient Library GuideTakamune ChoMaintainedMinor UpdateN/AAPPCLogging GuideTakamune ChoMaintainedNo ChangeN/AAPPC User
GuideTakamune ChoMaintainedMinor UpdateN/A
APPCOAM API GuideTakamune ChoMaintainedNo ChangeN/A


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

APPCClient Library
APPC CDT User
GuideTakamune ChoMaintainedMinor UpdateN/A
PORTALRelease NotesLorraine WelchMaintainedMinor UpdateN/ADid not attendDid not attendRC0INTEGRATIONUser Guide

Morgan Richomme

MaintainedMinor updateN/AINTEGRATIONCI Guide

Morgan Richomme

NewInitial 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 ChangeN/A

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

APPC CDT User GuideTakamune ChoMaintainedMinor UpdateN/A

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

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

INTEGRATIONUser Guide

Morgan Richomme

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

INTEGRATIONCI Guide

Morgan Richomme

NewInitial 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

Pamela Dragosh

MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/architecture/architecture.html

POLICYOffered APIs

Pamela Dragosh

MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/offeredapis.html

POLICYDevelopment Guide

Pamela Dragosh

MaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-policy-parent/en/frankfurt/development/development.html

EXTAPIArchitecture

Adrian OSullivan

MaintainedNo ChangeN/A

https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.htmlhttps://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 UpdateN/A

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

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

Adrian OSullivan : checked and valid

EXTAPIDeveloper Guide

Adrian OSullivan

POLICYArchitecturePamela Dragosh

MaintainedMinor UpdateN/A

https://onap
-doc
.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.htmlhttps://onap.readthedocs.
io/projects/onap-policy-parent/en/latest/architecture/architecture.html
io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.htmlLink to http, no https - http still supported locally
EXTAPIInstallation

Adrian OSullivan

POLICYOffered APIsPamela Dragosh

MaintainedMinor UpdateN/A

https://onap
-docPOLICYDevelopment Guide

Pamela Dragosh

MaintainedMinor UpdateN/A
.readthedocs.io
/projects/onap-policy-parent/en/latest/offeredapis.html
/en/frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html
https://onap
-doc
.readthedocs.io/
projects/onap-policy-parent/en/latest/development/development.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

user-67d6f

EXTAPIArchitectureAdrian OSullivan

MaintainedNo ChangeN/A

https://docs.onap.
readthedocs.io
org/en/latest/submodules/
externalapi
vnfsdk/
nbi.git/docs/architecture/architecture.htmlEXTAPIOffered APIsAdrian OSullivanMaintainedMinor UpdateN/A
model.git/docs/files/vnf-test-platform.htmlhttps://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
externalapi
vnfsdk/
nbi
model.git/docs/
offeredapis/offeredapis
files/vnf-test-platform.html
EXTAPIConsumed APIs

VNFSDKMarketplace/VTP API

user-67d6f

Adrian OSullivan

Maintained
Minor Update
No ChangeN/A

https://docs.onap.
readthedocs.io
org/en/latest/submodules/
externalapi
vnfsdk/
nbi
model.git/docs/
consumedapis
files/
consumedapis
marketplace-overview.html
EXTAPIDeveloper GuideAdrian OSullivan
MaintainedMinor UpdateN/A
https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
externalapi
vnfsdk/
nbi
model.git/docs/
architecture/NBI_Developer_Guide
files/marketplace-overview.html
EXTAPI

VNFSDK
Installation
User Guide

user-67d6f

Adrian OSullivan

Maintained
Minor Update
No ChangeN/A

https://docs.onap.
readthedocs.io
org/en/latest/submodules/
externalapi
vnfsdk/
nbi
model.git/docs/
installation/installation.htmlVNFSDKArchitecture

Weitao Gao

MaintainedNo ChangeN/AVNFSDKMarketplace/VTP API

Weitao Gao

MaintainedNo ChangeN/A
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
VNFSDKUser Guide

Weitao Gao

MaintainedNo ChangeN
/A

https://

docs

onap-doc.

onap

readthedocs.

org

io/

en

projects/

latest

onap-so/

guides

en/

onap-developer

frankfurt/

developing/index.html#service-orchestration

api/offered_consumed_apis.html



 SO
 API
 Architecture Seshu Kumar Mudiganti Maintained Minor Update N/A

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


OOF
 Architecture Seshu Kumar Mudiganti Maintained Minor Update N/A
ArchitectureShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

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

OOFHoming Specification Guide
OOFArchitecture
Shankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A
OOF


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

OOFAPI
Homing Specification Guide
Shankaranarayanan Puzhavakath NarayananMaintainedMinor update
N/A
N/A

https://onap-doc.readthedocs.io/projects/onap-optf-osdf/en/frankfurt/sections/offeredapis.html
OOFAPIShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A


OOMSetup Guide
Mike Elliott

Sylvain Desbureaux

MaintainedMinor updateN/A


https://onap-doc.readthedocs.io/projects/onap-oom/en/latest/index.html#master-index(tick)
OOMRelease Notes
Mike Elliott

Sylvain Desbureaux

MaintainedMinor updateN/A




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

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

VF-CInstallation Guide

Yan Yang

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

CCSDKCDS User Guide

Yuriy Malakov

MaintainedMinor 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 Notes

user-67d6f

MaintainedMinor UpdateN/A




VVPVNF Validation Documentation

steven stark

MaintainedMinor updateNANANAVNF Validation Documentation

VNFRQTSVNF and PNF Requirements and Guidelines

Trevor Lovett

MaintainedMinor UpdateNANANA
VNF and PNF Requirements and GuidelinesAAIOffered APIs
VNF and PNF Requirements and Guidelines

AAIOffered APIs

James Forsyth

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

AAIAAI REST API

James Forsyth

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

AAIRelease Notes

James Forsyth

MaintainedMinor UpdateN
/AAAIRelease Notes

James Forsyth

MaintainedMinor Update
/A(error)(error)https://onap-doc.readthedocs.io/projects/onap-aai-aai-common/en/frankfurt/release-notes.html
N/A


MUSICArchitecture and Usage

Bharath Balasubramanian

MaintainedMinor 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)
DCAEArchitecture

Vijay Venkatesh Kumar

MaintainedMinor Update


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

DCAERelease NotesVijay Venkatesh KumarMaintainedMinor Update


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

DCAEConsumed API's

Vijay Venkatesh Kumar

MaintainedMinor Update


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

DCAE

MOD User guide

Deven Panchal Vijay Venkatesh Kumar

NewInitial publicationPlaceholder - DCAE MOD User Guide

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

DCAEDCAE Service Components

Vijay Venkatesh Kumar

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

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

latest

frankfurt/submodules/dcaegen2.git/docs/sections/services/pm-subscription-handler/index.html



DCAEAcumos Adapter

Andrew Gauld Vijay Venkatesh Kumar  

NewInitial publicationPlaceholder - Acumos DCAE Integration

As this is POC, documentation will be maintained on WIKI



DMAAPArchitecture and Usage

Mandar Sawant

MaintainedNo Change


Data Router

Bus Controller

Message Router



DMAAPRelease Notes

Mandar Sawant

MaintainedMinor 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

AAFWIKI

Jonathan Gathman

MaintainedAdmin/ReleaseApplication Authorization Framework (AAF) Documentation




AAFMain Docs

Jonathan Gathman

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

AAF Read-the-Docs

AAFAPI Docs

Jonathan Gathman

MaintainedMove content to Swagger in Frankfurt

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

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.

readthedocs.io

org/en/

latest

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



Usecase-UIUser Guide

xu ran

MaintainedMinor UpdateN/A
(tick)https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/usecase-ui.git
/docs
/docs/platform/installation/user-guide/index.html

Usecase-UIInstallation Guide

xu ran

MaintainedMinor UpdateN/A

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












SDC
Release notes
Delivery

Ofir Sonsino

Maintained
Major
Minor updateN/A

https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
sdc.git/docs/index.html
sdc.git/docs/index.html

HolmesRelease Notes

Guangrong Fu

MaintainedMinor updateN/A




HolmesUser GuideGuangrong FuMaintainedMinor updateN/A




HolmesArchitecture

Guangrong Fu

MaintainedMinor updateN/A




MSBRelease NotesHuabing Zhao
SDCDeliveryOfir Sonsino
MaintainedMinor updateN/A

https://docs.onap.
readthedocs.io
org/en/
latest
frankfurt/submodules/
sdc
msb/apigateway.git/docs/
index.htmlHolmesRelease Notes

Guangrong Fu

MaintainedMinor updateN/A
release-notes.html
(tick)
MSB
Holmes
User Guide
Guangrong Fu
Huabing ZhaoMaintainedMinor updateN/A
HolmesArchitecture

Guangrong Fu

MaintainedMinor updateN/A


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


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

...