Istanbul Documentation

Istanbul Documentation

Short Explanation

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

Non-Relevant Repositories

  • Containing documentation repositories no longer relevant for the upcoming release

Unmaintained Repositories

  •  Existing repositories containing documents,

    •  which are belonging to an active project, but not used in the ONAP documentation

    •  which are belonging to an unmaintained project, but used in the ONAP documentation

  • Table handled mainly by DOC, but PROJECTS are asked to check if status of repository has changed.

  • A request to the PROJECTS: Please check the table "Unmaintained Repositories" and move entry to the upper table, if the repository is once again maintained in the target 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 | maintained | remove ; 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'

repo 'master' exists
'latest' available in RTD


Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

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

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 | maintained | remove ; 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'

repo 'master' exists
'latest' available in RTD


Responsibility:
DOC (Checkpoint)

Documentation available:
RTD 'branch'

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

Responsibility:
DOC (Checkpoint)

M2

M2

M2

M2

M2

M4

RC0

AAI

aai/aai-common

AAI Documentation Repository

Maintained

@William Reehil

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

AAI

aai/sparky-be

Sparky - Inventory UI Service

Maintained

@William Reehil

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available (AAI common)

CCSDK

ccsdk/cds

CONTROLLER DESIGN STUDIO (CDS)

Maintained

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available (CCSDK)

CCSDK

ccsdk/distribution

Common Controller Software Development Kit

Maintained

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

CCSDK

ccsdk/features

SDN-R Online help

Maintained

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available (CCSDK)

CCSDK

ccsdk/oran

ccsdk/oran

Maintained

@Dan Timoney

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available (CCSDK)

CLI

cli

ONAP CLI

Maintained

@Former user (Deleted)

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

-    no changes - release notes not required

CPS

cps

CPS Documentation



@Toine Siebelink

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

CPS

cps/cps-temporal

CPS Temporal

new

@Former user (Deleted)

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available

CPS

cps/ncmp-dmi-plugin

DMI-Plugin Documentation

new

@Toine Siebelink

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available

DCAE

dcaegen2

Data Collection Analytics and Events (DCAE)

maintained

@Vijay Kumar

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

DMAAP

dmaap/buscontroller

dmaap/buscontroller

maintained

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

DMAAP

dmaap/datarouter

DMaaP Data Router

maintained

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

DMAAP

dmaap/messagerouter/messageservice

dmaap/message router(MR)

maintained

@Fiachra Corcoran

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

DOC



ArchSubCom

doc

Open Network Automation Platform

maintained (doc)



Architecture Update

@Thomas Kulik (doc)



Architecture Update

repo 'master' exists

'latest' available in RTD

Architecture Update

repo branched

'branch' available in RTD

release notes available

HOLMES

holmes/engine-management

Holmes

maintained

@Guangrong Fu

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available (rule-management)

HOLMES

holmes/rule-management

Holmes

maintained

@Guangrong Fu

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

 release notes available

INTEGRATION

integration

INTEGRATION

maintained

@Michał Jagiełło 

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

MODELING

modeling/etsicatalog

Etsicatalog Project

maintained

@Yuanhong Deng

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

MODELING

modeling/modelspec

Model Specifications

maintained

@Yuanhong Deng 

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

MSB

msb/apigateway

MSB(Microservices Bus)

maintained

@Jinquan Ni

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

MULTICLOUD

multicloud/framework

MultiCloud Architecture

maintained

@Bin Yang

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

OOM

oom

OOM Documentation Repository

maintained

@Sylvain Desbureaux 

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes available

OOM

oom/offline-installer

OOM offline-installer

maintained

@Sylvain Desbureaux 

repo 'master' exists

'latest' available in RTD

repo branched

'branch' available in RTD

release notes not required

OOM

oom/platform/cert-service

OOM Certification Service

maintained

@Sylvain Desbureaux 

repo 'master' exists