New Delhi Documentation

New Delhi Documentation

TABLE OF CONTENTS

**** Work in Progress for New Delhi ****

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

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)

( see also History of PTL )

Responsibility:
PROJECT

Documentation available:
RTD 'latest'

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

docs config up-to-date
repo 'master' exists
'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

release branch exists
release branch available in RTD
release notes available 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)

( see also History of PTL )

Responsibility:
PROJECT

Documentation available:
RTD 'latest'

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

docs config up-to-date
repo 'master' exists
'latest' available in RTD

Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

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

Responsibility:
DOC (Checkpoint)



M?

M?

M?

M?

M?

M?

RC0

01

AAI [CORE PROJECT]

aai/aai-common

AAI Documentation Repository



no PTL since 2022-12-02

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

02

AAI [CORE PROJECT]

aai/sparky-be

Sparky - Inventory UI Service



no PTL since 2022-12-02

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

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

03

CCSDK

ccsdk/apps

CCSDK APPS DOCUMENTATION REPOSITORY



@Dan Timoney

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

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

04

CCSDK

ccsdk/cds

CONTROLLER DESIGN STUDIO (CDS)



@Dan Timoney

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

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

05

CCSDK

ccsdk/distribution

Common Controller Software Development Kit



@Dan Timoney

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

06

CCSDK

ccsdk/features

SDN-R Online help



@Dan Timoney

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

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

07

CCSDK

ccsdk/oran

ccsdk/oran



@Dan Timoney

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

08

CLI

cli

ONAP CLI



@Dan Xu

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

09

CPS

cps

CPS Documentation



@Toine Siebelink

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

10

CPS

cps/ncmp-dmi-plugin

DMI-Plugin Documentation



@Toine Siebelink

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

11

DCAE [CORE PROJECT]

dcaegen2

Data Collection Analytics and Events (DCAE)



no PTL since 2022-12-01

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

 release notes available in RTD and updated

12

DMAAP

dmaap/buscontroller

dmaap/buscontroller



@Fiachra Corcoran

no PTL since 2024-01-xx ???

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

 release notes available in RTD and updated

13

DMAAP

dmaap/datarouter

DMaaP Data Router



@Fiachra Corcoran

no PTL since 2024-01-xx ???

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

 release notes available in RTD and updated

14

DMAAP

dmaap/messagerouter/messageservice

dmaap/message router(MR)



@Fiachra Corcoran

no PTL since 2024-01-xx ???

DEPRECATED

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

 release notes available in RTD and updated

15

DOC







ArchSubCom

doc

Open Network Automation Platform







ONAP Architecture



@Thomas Kulik (doc)





@Byung-Woo Jun  

docs config up-to-date

repo 'master' exists

'latest' available in RTD



Architecture updated

release branch exists

release branch available in RTD

release notes (doc) available in RTD and updated

release notes (composite) available in RTD and updated

Architecture updated

16

HOLMES

holmes/engine-management

Holmes



@Guangrong Fu

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

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

17

HOLMES

holmes/rule-management

Holmes



@Guangrong Fu

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

18

INTEGRATION

integration

INTEGRATION



@Marek Szwałkiewicz 

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes available in RTD and updated

19

MODELING

modeling/etsicatalog

Etsicatalog Project

to be moved under SO?

@Hui Deng 

docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists