Oslo Documentation

Oslo Documentation

TABLE OF CONTENTS

**** Work in Progress for Oslo ****

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

Core Project

(is the project a core component of ONAP?)

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

Core Project

(is the project a core component of ONAP?)

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)

















RC0

01

AAI

aai/aai-common

AAI Documentation Repository

yes



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

aai/sparky-be

Sparky - Inventory UI Service

yes



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

yes as an ONAP common shared utility

  • SDNC uses it



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

yes as an ONAP common shared utility for:

  • SDNC

  • 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

yes as an ONAP common shared utility for:

  • SDNC



@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

yes as an ONAP common shared utility for: 

  • SDNC



@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

yes as an ONAP common shared utility for:

  • SDNC

  • A1 controller



@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

CPS

cps

CPS Documentation

yes



@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

09

CPS

cps/ncmp-dmi-plugin

DMI-Plugin Documentation

yes



@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

DCAE

dcaegen2

Data Collection Analytics and Events (DCAE)

yes



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

11

DOC







doc

Open Network Automation Platform







to be defined



@Thomas Kulik (doc)




docs config up-to-date

repo 'master' exists

'latest' available in RTD

release branch exists

release branch available in RTD

release notes (doc) available in RTD and updated

release notes (composite) available in RTD and updated

12

ARCCOM

doc

ONAP Architecture

Yes; it is a committee and defining over ONAP architecture



@Byung-Woo Jun 

Architecture updated

Architecture updated

13

INTEGRATION

integration

INTEGRATION

to be defined



@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

14

MULTICLOUD

multicloud/framework

MultiCloud Architecture

to be defined



no PTL since 2023-04-24

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

MULTICLOUD

multicloud/k8s

MultiCloud Kubernetes Plugin

to be defined



no PTL since 2023-04-24

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 (multicloud/framework)

16

OOM

oom

OOM Documentation Repository

yes for:

  • build and deployment

  • security



@Andreas Geißler 

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

17

POLICY

policy/parent

Policy Framework Architecture

yes



@Ramesh Murugan Iyer 

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

Portal-NG

portal-ng/ui