/
Frankfurt Documentation

Frankfurt Documentation

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

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

CLAMPRelease NoteMaintainedMajor 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/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/frankfurt/submodules/modeling/etsicatalog.git/docs/index.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


MultiCloudArchitectureMaintainedNo ChangeN/A

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

No Frankfurt Branch !

Still API V1 vesion documented

MultiCloudUser GuideMaintainedNo 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 GuideTakamune ChoMaintainedMinor UpdateN/A

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

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 A. 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


POLICYArchitectureMaintainedMinor UpdateN/A

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

POLICYOffered APIsMaintainedMinor UpdateN/A

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

POLICYDevelopment GuideMaintainedMinor UpdateN/A

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

EXTAPIArchitectureMaintainedNo 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 GuideMaintainedMinor UpdateN/A

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

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

VNFSDKArchitectureMaintainedNo ChangeN/A

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

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 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 KumarMaintainedMinor Update


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