Jakarta Documentation

Jakarta Documentation

IMPORTANT NOTE

Beginning with the 'Jakarta' release a project/repository contributing to the documentation of the release needs to ...

  • be actively maintained

  • create a branch for the new release

IMPORTANT NOTE

Beginning with the 'Jakarta' release a project/repository contributing to the documentation of the release needs to ...

  • be actively maintained

  • create a branch for the new release

TABLE OF CONTENTS

Short Explanation

Table: Maintained Repositories

  • Containing documentation repositories for the upcoming release

  • Table handled commonly by the ONAP projects and the Documentation team.

  • In the column header you find the responsibility for this column (DOC|PROJECT).

Table: Non-Relevant Repositories

  • Containing documentation repositories no longer relevant for the upcoming release

Unmaintained Repositories

Beginning with the 'Jakarta' release, unmaintained projects/repositories are no longer contributing to the documentation if there is no TSC exception.

Maintained Repositories Table

#

Project Name

(common abbreviation of the project or subcommittee)

Responsibility:
Prefill: DOC
Update: PROJECT

Repository Name

(contains documentation to be published with the upcoming release)

Responsibility:
Prefill: DOC
Update: PROJECT

ReadTheDocs Link

(link pointing to RTD 'latest' main index.rst; main title used in index.rst)

Responsibility:
Prefill: DOC
Update: PROJECT

Repository Status

(new | changed | remove ; status of documentation; needed to e.g. identify changes in the intersphinx linking)

Responsibility:
PROJECT

Documentation Owner(s)

(responsible for documentation in this repo; please use @ notation for the name)

Responsibility:
PROJECT

Documentation available:
RTD 'latest'

(relevant for new repos which are participating the first time)

repo 'master' exists
'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

repo 'branch' exists
'branch' available in RTD
release notes available in RTD and updated

Responsibility:
DOC (Checkpoint)

#

Project Name

(common abbreviation of the project or subcommittee)

Responsibility:
Prefill: DOC
Update: PROJECT

Repository Name

(contains documentation to be published with the upcoming release)

Responsibility:
Prefill: DOC
Update: PROJECT

ReadTheDocs Link

(link pointing to RTD 'latest' main index.rst; main title used in index.rst)

Responsibility:
Prefill: DOC
Update: PROJECT

Repository Status

(new | changed | remove ; status of documentation; needed to e.g. identify changes in the intersphinx linking)

Responsibility:
PROJECT

Documentation Owner(s)

(responsible for documentation in this repo; please use @ notation for the name)

Responsibility:
PROJECT

Documentation available:
RTD 'latest'

(relevant for new repos which are participating the first time)

repo 'master' exists
'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

repo 'branch' exists
'branch' available in RTD
release notes available in RTD and updated

Responsibility:
DOC (Checkpoint)

 

M2

M2

M2

M2

M2

M4

RC0

01

AAI

aai/aai-common

AAI Documentation Repository

Minor changes for Jakarta

@William Reehil

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

02

AAI

aai/sparky-be

Sparky - Inventory UI Service

Repo status: No change

Doc status: No change

@William Reehil

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated (aai/aai-common)

03

CCSDK

ccsdk/apps

CCSDK APPS DOCUMENTATION REPOSITORY

Repo status: No change

Doc status: No change

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated (ccsdk/distribution)

04

CCSDK

ccsdk/cds

CONTROLLER DESIGN STUDIO (CDS)

Changes expected for Jakarta

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available in RTD and updated (ccsdk/distribution) 

05

CCSDK

ccsdk/distribution

Common Controller Software Development Kit

Changes expected for Jakarta

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

06

CCSDK

ccsdk/features

SDN-R Online help

Changes expected for Jakarta

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated (ccsdk/distribution)

07

CCSDK

ccsdk/oran

ccsdk/oran

Changes expected for Jakarta

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

08

CLI

cli

ONAP CLI

Repo status: No change

Doc status: No change

@Former user (Deleted)

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

09

CPS

cps

CPS Documentation

 

@Toine Siebelink

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

10

CPS

cps/cps-temporal

CPS Temporal

 

@Former user (Deleted)

repo 'master' exists

'latest' available in RTD

repo branched

 'branch' available in RTD

release notes available in RTD and updated

11

CPS

cps/ncmp-dmi-plugin

DMI-Plugin Documentation

 

@Toine Siebelink

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

12

DCAE

dcaegen2

Data Collection Analytics and Events (DCAE)

 

@Vijay Kumar

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available in RTD and updated

13

DMAAP

dmaap/buscontroller

dmaap/buscontroller

 

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available in RTD and updated

14

DMAAP

dmaap/datarouter

DMaaP Data Router

 

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available in RTD and updated

15

DMAAP

dmaap/messagerouter/messageservice

dmaap/message router(MR)

 

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available in RTD and updated

16

DOC

 

 

 

ArchSubCom

doc

Open Network Automation Platform

 

 

 

ONAP Architecture

 

 

 

 

Architecture Updates

@Thomas Kulik (doc)




@Chaker Al-Hakim 

repo 'master' exists

'latest' available in RTD

 

 

Architecture updated

repo branched

'branch' available in RTD

release notes (doc) available in RTD and updated

release notes (composite) available in RTD and updated

Architecture updated

17

HOLMES

holmes/engine-management

Holmes

Installation update due to https://lf-onap.atlassian.net/browse/HOLMES-488

@Guangrong Fu

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated (holmes/rule-management)

18

HOLMES

holmes/rule-management

Holmes

Installation update due to https://lf-onap.atlassian.net/browse/HOLMES-488

@Guangrong Fu

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

19

INTEGRATION

integration

INTEGRATION

 

@Michał Jagiełło 

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

20

MODELING

modeling/etsicatalog

Etsicatalog Project

Minor changes expected for Jakarta

@Yuanhong Deng

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available in RTD and updated

21

MODELING

modeling/modelspec

Model Specifications

 

@Xu Yang 

repo 'master' exists

'latest' available in RTD