Versions Compared

Version Old Version 77 New Version 78
Changes made by

Sofia Wallin

Eric Debeau

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/submodules/modeling/modelspec.git/docs/index.html

ModelingETSI CatalogYuanhong DengMaintainedMinor UpdateN/A(tick)

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



MultiCloudArchitecture

Bin Yang

MaintainedNo ChangeN/A

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

MultiCloudUser Guide

Bin Yang

MaintainedNo ChangeN/A

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

APPCLCM API GuideTakamune ChoMaintainedMinor UpdateN/A

https://onap-doc.readthedocs.io/projects/onap-appc/en/latest/APPC-LCM-API-Guide/APPC-LCM-API-Guide.html#appc-lcm-api-guide

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/ADid not attendDid not attendRC0

INTEGRATIONUser Guide

Morgan Richomme

MaintainedMinor updateN/A




INTEGRATIONCI Guide

Morgan Richomme

NewInitial publication

see OOM Gating

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




https://onap-doc.readthedocs.io/projects/onap-integration/en/latest/index.html#master-index(tick)
POLICYArchitecture

Pamela Dragosh

MaintainedMinor UpdateN/A

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

POLICYOffered APIs

Pamela Dragosh

MaintainedMinor UpdateN/A

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

POLICYDevelopment Guide

Pamela Dragosh

MaintainedMinor UpdateN/A

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

EXTAPIArchitecture

Adrian OSullivan

MaintainedNo ChangeN/A

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

EXTAPIOffered APIsAdrian OSullivanMaintainedMinor UpdateN/A

https://onap.readthedocs.io/en/latest/submodules/externalapi/nbi.git/docs/offeredapis/offeredapis.html

EXTAPIConsumed APIsAdrian OSullivanMaintainedMinor UpdateN/A

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

EXTAPIDeveloper Guide

Adrian OSullivan

MaintainedMinor UpdateN/A

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

EXTAPIInstallation

Adrian OSullivan

MaintainedMinor UpdateN/A

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

VNFSDKArchitecture

victor gao

MaintainedNo ChangeN/A




VNFSDKMarketplace/VTP API

victor gao

MaintainedNo ChangeN/A




VNFSDKUser Guide

victor gao

MaintainedNo ChangeN/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

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

 SO Architecture Seshu Kumar Mudiganti Maintained Minor Update N/A




OOFArchitectureShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

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

OOFHoming Specification GuideShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

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

OOFAPIShankaranarayanan Puzhavakath NarayananMaintainedMinor updateN/A

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

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/submodules/vfc/nfvo/lcm.git/docs/platform/APIs/index.html

VF-CUser GuideYan YangMaintainedMinor updateN/A(tick)
https://onap.readthedocs.io/en/latest/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/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

Former user (Deleted)

MaintainedMinor UpdateN/A




VVPVNF Validation Documentation

steven stark

MaintainedMinor updateNANANAVNF Validation Documentation

VNFRQTSVNF and PNF Requirements and Guidelines

Trevor Lovett

MaintainedMinor UpdateNANANAVNF and PNF Requirements and Guidelines

AAIOffered APIs

James Forsyth

MaintainedMinor UpdateN/A




AAIAAI REST API

James Forsyth

MaintainedMinor UpdateN/A




AAIRelease Notes

James Forsyth

MaintainedMinor UpdateN/A




MUSICArchitecture and Usage

bharathb

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 Kumar

MaintainedMinor Update


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

DCAEConsumed API's

Vijay Kumar

MaintainedMinor Update


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

DCAE

MOD User guide

Deven Vijay Kumar

NewInitial publicationPlaceholder - DCAE MOD User Guide

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

DCAEDCAE Service Components

Vijay Kumar

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

https://docs.onap.org/en/latest/submodules/dcaegen2.git/docs/sections/services/pm-subscription-handler/index.html



DCAEAcumos Adapter

Andrew Gauld Vijay Kumar  

NewInitial publicationPlaceholder - Acumos DCAE Integration

As this is POC, documentation will be maintained on WIKI

Acumos Adapter Installation

Acumos DCAE Integration



DMAAPArchitecture and Usage

Mandar Sawant

MaintainedNo Change





DMAAPRelease Notes

Mandar Sawant

MaintainedMinor Change





VIDRelease NotesittayMaintained

Minor Update

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

ittay , automatically generated

Maintained

No Change

n/a(error)(error)


VIDUser GuideittayMaintained

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 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://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/release-notes.html

Usecase-UIUser Guide

xu ran

MaintainedMinor UpdateN/A
(tick)https://onap.readthedocs.io/en/latest/submodules/usecase-ui.git/docs/index.html

Usecase-UIInstallation Guide

xu ran

MaintainedMinor UpdateN/A

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

SDCRelease notes

Ofir Sonsino

MaintainedMajor updateN/A

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

SDCDelivery

Ofir Sonsino

MaintainedMinor updateN/A

https://onap.readthedocs.io/en/latest/submodules/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 ZhaoMaintainedMinor updateN/A

https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/release-notes.html

MSBUser GuideHuabing ZhaoMaintainedMinor updateN/A

https://docs.onap.org/en/frankfurt/submodules/msb/apigateway.git/docs/platform/user-guide.html

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

...