Guilin Documentation

Guilin Documentation

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 <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark  if attended)

Attended Doc Hackathon 2 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark  if attended)

Link to Final Documentation in ReadTheDocs (stable/guilin 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-M4

RC2





CLAMP

Architecture

@Gervais-Martial Ngueko

Maintained

No Change

N/A





CLAMP Architecture





POLICY

Architecture

@Ram Krishna Verma

Maintained

Minor Update

N/A



Policy Framework Architecture





POLICY

Offered APIs

@Ram Krishna Verma

Maintained

Minor Update

N/A



Policy Offered APIs





POLICY

Development Guide

@Ram Krishna Verma

Maintained

Minor Update

N/A



Policy Platform Development





HOLMES

Architecture

@Guangrong Fu

Maintained

No Change

N/A





Holmes Architecture





HOLMES

Offered APIs

@Guangrong Fu

Maintained

No Change

N/A





Offered APIs





HOLMES

Consumed APIs

@Guangrong Fu

Maintained

Minor Update

N/A





Consumed APIs





HOLMES

Installation

@Guangrong Fu

Maintained

Minor Update

N/A





https://docs.onap.org/projects/onap-holmes-rule-management/en/guilin/platform/installation.html



Modeling

Architecture

@Yuanhong Deng

Maintained

Minor Update

N/A











Modeling

Offered APIs

@Yuanhong Deng

Maintained

Minor Update

N/A











OOF

Architecture

@krishna moorthy

Maintained

Minor Update

N/A



OOF Architecture





OOF

Offered APIs

@krishna moorthy

Maintained

Minor Update

N/A



OOF Offered APIs





OOF

Release Notes

@krishna moorthy

Maintained

Minor Update

N/A



OOF Release Notes

 updated but need to remove "release date"



VFC

Offered APIs

@Yuanhong Deng

Maintained

Minor Update

N/A











SO

Architecture

@Seshu Kumar Mudiganti

Maintained

Minor Update

N/A











SO

Offered APIs

@Seshu Kumar Mudiganti

Maintained

Minor Update

N/A











SO

Development Guide

@Seshu Kumar Mudiganti

Maintained

Minor Update

N/A











VID

Release Notes

@ittay

Maintained

Minor Update

N/A





https://docs.onap.org/projects/onap-vid/en/guilin/release-notes.html#release-notes

 Updated but not using the new template



VID

Swagger API

@ittay , automatically generated

Maintained

No Change

N/A











VID

User Guide

@ittay

Maintained

No Change

N/A











Usecase UI

Release Notes

@xu ran

Maintained

Minor Update

N/A





Usecase-UI Release Notes

 Updated but not using the new template



Usecase UI

User Guide

@xu ran

Maintained

Minor Update

N/A





https://docs.onap.org/projects/onap-usecase-ui/en/guilin/platform/installation/user-guide/uui-guide.html



Usecase UI

Installation Guide

@xu ran

Maintained

No Change

N/A





https://docs.onap.org/projects/onap-usecase-ui/en/guilin/platform/installation/installation/uui-over-oom.html



SDC

Architecture

@ChrisC

Maintained

Minor Update

N/A



(Oct DDF)

SDC Documentation



SDC

Release Notes

@ChrisC

Maintained

Minor Update

N/A



(Oct DDF)

SDC Release Note

 Updated but not using the new template



AAI

Offered APIs

@William Reehil

Maintained

Minor Update







https://docs.onap.org/projects/onap-aai-aai-common/en/guilin/AAI%20REST%20API%20Documentation/AAIRESTAPI.html#aai-api-definition