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

Attended Doc Hackathon 2 on March 25

(Document owner must attend at least one hackathon)

(fill in green checkmark  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! 

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

Attended Doc Hackathon 2 on March 25

(Document owner must attend at least one hackathon)

(fill in green checkmark  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-M4

RC0

RC2



CLAMP

Architecture

@Gervais-Martial Ngueko

Maintained

Minor Update

N/A





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





CLAMP

User Guide

@Gervais-Martial Ngueko

Maintained

Minor Update

N/A





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





CLAMP

Release Note

@Gervais-Martial Ngueko

Maintained

Major Update

N/A





https://onap-doc.readthedocs.io/projects/onap-clamp/en/frankfurt/release-notes.html#release-notes



Release date need to be updated

Modeling

Model Spec

@Xu Yang

Maintained

Minor Update

N/A





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



Still reference to Dublin

No Frankfurt branch

Modeling

ETSI Catalog

@Yuanhong Deng

Maintained

Minor Update

N/A



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



MultiCloud

Architecture

@Bin Yang

Maintained

No Change

N/A





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



No Frankfurt Branch !

Still API V1 vesion documented

MultiCloud

User Guide

@Bin Yang

Maintained

No Change

N/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

APPC

LCM API Guide

@Takamune Cho

Maintained

Minor Update

N/A





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





APPC

Client Library Guide

@Takamune Cho

Maintained

Minor Update

N/A





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





APPC

Logging Guide

@Takamune Cho

Maintained

No Change

N/A





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





APPC 

User Guide

@Takamune Cho

Maintained

Minor Update

N/A





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





APPC

OAM API Guide

@Takamune Cho

Maintained

No Change

N/A





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





APPC 

CDT User Guide

@Takamune Cho

Maintained

Minor Update

N/A





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





PORTAL

Release Notes

@Lorraine A. Welch

Maintained

Minor Update

N/A

RC0





INTEGRATION

User Guide

@Morgan Richomme

Maintained

Minor update

N/A

https://docs.onap.org/en/frankfurt/submodules/integration.git/docs/index.html?highlight=integration





INTEGRATION

CI Guide

@Morgan Richomme

New

Initial publication

see OOM Gating

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

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





POLICY

Architecture

@Pamela Dragosh

Maintained

Minor Update

N/A





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





POLICY

Offered APIs

@Pamela Dragosh

Maintained

Minor Update

N/A





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





POLICY

Development Guide

@Pamela Dragosh

Maintained

Minor Update

N/A





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





EXTAPI

Architecture

@Adrian OSullivan

Maintained

No Change

N/A





https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/architecture.html

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 

EXTAPI

Offered APIs

@Adrian OSullivan

Maintained

Minor Update

N/A





https://docs.onap.org/en/frankfurt/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html

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

EXTAPI

Consumed APIs

@Adrian OSullivan

Maintained

Minor Update

N/A





https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/consumedapis/consumedapis.html

https://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

EXTAPI

Developer Guide

@Adrian OSullivan

Maintained

Minor Update

N/A





https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html

https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/architecture/NBI_Developer_Guide.html

Link to http, no https - http still supported locally

EXTAPI

Installation

@Adrian OSullivan

Maintained

Minor Update

N/A





https://onap.readthedocs.io/en/frankfurt/submodules/externalapi/nbi.git/docs/installation/installation.html

https://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

VNFSDK

Architecture

@Former user (Deleted)

Maintained

No Change

N/A





https://docs.onap.org/en/latest/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html

https://docs.onap.org/en/frankfurt/submodules/vnfsdk/model.git/docs/files/vnf-test-platform.html



VNFSDK

Marketplace/VTP API