Versions Compared

Old Version 11

changes.mady.by.user Sofia Wallin

Saved on

compared with

New Version Current

changes.mady.by.user Andreas Geißler

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Virtual Event

This event will be be a virtual hacking session focusing on the Guilin Release. The call with be open xx-xx UTC. 

...

  • Learn more about how to work with documentation
  • Guilin specific updates
  • Documentation reviews
  • <addme>


Time zoneDateTimeParticipantsCETSeptember 30th13:00-16:30
NameTopic/taskOutcome

Andreas Geißler
Thomas Kulik
(12:00-15:00)

  • Complete the list of existing documents (Guilin Documentation)
  • Add git project reference to list
  • Possible automation for list... (maybe via Jenkins)
  • Verify list with PTLs, if incomplete
Updated our Working Review List (Copy of Guilin Documentation (working version for reviews))

Andreas Geißler
Thomas Kulik
(12:00-15:00)

  • Put to TSC agenda to come up with a Release strategy.

  • Add for each project a release branch,....

Sofia Wallin

Release requirement for documentation   

We need to create clear requirements for release documentation. Each project need to be aware of what's expected and this need to be tracked by the release manager.

Suggestion to create a table with projects categorised with associated documentation forming an initinal set of release documentation

Date and Time

Sofia Wallin

 (moderator)EDTSeptember 30thPSTSeptember 30th

Logistics:

https://zoom.us/j/92987486389?pwd=QUdnMVVjZS83Y0dEalA2Y01UQzhEZz09

Document List (Work in progress for Hackathon):

Project Name

Document TitleRST-FileRTD-Link

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 (tick) if attended)

Attended Doc Hackathon 2 on <date>

(Document owner must attend at least one hackathon)

(fill in green checkmark (tick) 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-M4RC2CLAMPArchitecturehttps://git.onap.org/clamp/tree/docshttps://docs.onap.org/projects/onap-clamp/en/latest/index.html#master-index

Gervais-Martial Ngueko

MaintainedMinor UpdateN/APOLICYArchitecture

Ram Krishna Verma

MaintainedMinor UpdateN/APOLICYOffered APIs

Ram Krishna Verma

MaintainedMinor UpdateN/APOLICYDevelopment Guide

Ram Krishna Verma

MaintainedMinor UpdateN/AHOLMESArchitecture

Guangrong Fu

MaintainedNo ChangeN/AHOLMESOffered APIs

Guangrong Fu

MaintainedNo ChangeN/AHOLMESConsumed APIs

Guangrong Fu

MaintainedMinor UpdateN/AHOLMESInstallation

Guangrong Fu

MaintainedMinor UpdateN/AModelingArchitecture
Yuanhong Deng
MaintainedMinor UpdateN/AModelingOffered APIs
Yuanhong Deng
MaintainedMinor UpdateN/AOOFArchitecture

krishna moorthy

MaintainedMinor UpdateN/AOOFOffered APIs

krishna moorthy

MaintainedMinor UpdateN/AOOFRelease Notes

krishna moorthy

MaintainedMinor UpdateN/AVFCOffered APIs
Yuanhong Deng
MaintainedMinor UpdateN/ASOArchitecture
Seshu Kumar Mudiganti
MaintainedMinor UpdateN/ASOOffered APIs

Seshu Kumar Mudiganti

MaintainedMinor UpdateN/ASODevelopment Guide

Seshu Kumar Mudiganti

MaintainedMinor UpdateN/AVIDRelease Notes
ittay
MaintainedMinor UpdateN/AVIDSwagger API

ittay , automatically generated

MaintainedNo ChangeN/AVIDUser Guide
ittay
MaintainedNo ChangeN/AUsecase UIRelease Notes

xu ran

MaintainedMinor UpdateN/AUsecase UIUser Guide

xu ran

MaintainedMinor UpdateN/AUsecase UIInstallation Guide

xu ran

MaintainedNo ChangeN/ASDCArchitecture
ChrisC
MaintainedMinor UpdateN/ASDCRelease Notes

ChrisC

MaintainedMinor UpdateN/AAAIOffered APIshttps://git.onap.org/aai/aai-common/tree/docs/platformhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/index.html#master-index

William Reehil

MaintainedMinor UpdateAAIAAI REST APIhttps://git.onap.org/aai/aai-common/tree/docs/AAI%20REST%20API%20Documentationhttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/AAI%20REST%20API%20Documentation/AAIRESTAPI.html
William Reehil
MaintainedMinor UpdateAAIRelease Noteshttps://git.onap.org/aai/aai-common/tree/docs/release-notes.rsthttps://docs.onap.org/projects/onap-aai-aai-common/en/latest/release-notes.html
William Reehil
MaintainedMinor UpdateAAIESR GUIhttps://git.onap.org/aai/esr-gui/tree/docshttps://docs.onap.org/projects/onap-aai-esr-gui/en/latest/index.html#master-index?AAIESR Serverhttps://git.onap.org/aai/esr-server/tree/docshttps://docs.onap.org/projects/onap-aai-esr-server/en/latest/index.html#master-indexAAISparky BE Serverhttps://git.onap.org/aai/sparky-be/tree/docshttps://docs.onap.org/projects/onap-aai-sparky-be/en/latest/index.html#master-indexAAI

Event Client Documentation Repository

https://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-indexhttps://docs.onap.org/projects/onap-aai-event-client/en/latest/index.html#master-indexIntegrationRelease Notes

Morgan Richomme

MaintainedMinor UpdateIntegrationUser Guide including use case documentation

Morgan Richomme

MaintainedMinor UpdateIntegrationTest Developer Guide

Marek Szwałkiewicz

NewInitial PublicationMultiCloudArchitecture

Bin Yang

MaintainedNo ChangeN/AMultiCloudRESP API

Bin Yang

MaintainedNo ChangeN/AMultiCloudUser Guild

Bin Yang

MaintainedNo ChangeN/AONAP CLIRelease notes

Former user (Deleted)

MaintainedMinot updatesN/AVNFSDK

release notes

API

Former user (Deleted)

MaintainedMinot updatesN/ADCAEArchitecturehttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/architecture.html

Vijay Kumar

MaintainedMinor UpdateDCAERelease Noteshttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/release-notes.html
Vijay Kumar
MaintainedMinor UpdateDCAEOffered API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/offeredapis.html
Vijay Kumar
MaintainedMinor UpdateDCAEConsumed API'shttps://git.onap.org/dcaegen2/tree/docshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/consumedapis.html

Vijay Kumar

MaintainedMinor UpdateDCAE

MOD User guide

https://git.onap.org/dcaegen2/tree/docs/sections/design-components/DCAE-MODhttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/design-components/index-onboarding.html

Vijay Kumar

MaintainedMinor UpdateDCAEDCAE Service Componentshttps://git.onap.org/dcaegen2/tree/docs/sections/serviceshttps://docs.onap.org/projects/onap-dcaegen2/en/latest/sections/services/serviceindex.html

Vijay Kumar

MaintainedMinor Update on existing components + new Guilin componentsVVPVVP Documentation
steven stark
MaintainedMinor UpdateN/AVNFRQTSProvider Docs
Trevor Lovett
MaintainedMinor UpdateDMAAPArchitecture and Usage
Mandar Sawant
MaintainedNo ChangeN/ADMAAPRelease Notes
Mandar Sawant
MaintainedMinor ChangeN/APORTALRelease Notes

Sunder Tattavarada

MaintainedMajor UpdateN/ACCSDKCDS User Guidehttps://git.onap.org/ccsdk/cds/tree/docshttps://docs.onap.org/projects/onap-ccsdk-cds/en/latest/index.html#master-index

Yuriy Malakov

MaintainedMinor updateN/ACCSDKRelease Noteshttps://git.onap.org/ccsdk/distribution/tree/docshttps://docs.onap.org/projects/onap-ccsdk-distribution/en/latest/release-notes.html
Dan Timoney
MaintainedMinor updateN/ACCSDKCommon Controller Dashboardhttps://git.onap.org/ccsdk/dashboard/tree/docshttps://docs.onap.org/projects/onap-ccsdk-dashboard/en/latest/index.html#master-indexCCSDKCCSDK Platform Pluginshttps://git.onap.org/ccsdk/platform/plugins/tree/docshttps://docs.onap.org/projects/onap-ccsdk-platform-plugins/en/latest/index.html#master-indexCCSDKCCSDK APPShttps://git.onap.org/ccsdk/apps/tree/docshttps://docs.onap.org/projects/onap-ccsdk-apps/en/latest/index.html#master-indexCCSDKORANhttps://git.onap.org/ccsdk/oran/tree/docsSDNCOffered APIs
Dan Timoney
MaintainedMinor UpdateSDNCRelease Notes
Dan Timoney
MaintainedMinor UpdateN/ADOCRelease Noteshttps://git.onap.org/doc/tree/docs/release-notes.rsthttps://docs.onap.org/en/latest/release/index.html
Sofia Wallin
MaintainedMinor UpdateN/ADOCLanding pagehttps://git.onap.org/doc/tree/docshttps://docs.onap.org/en/latest/index.html
Sofia Wallin
MaintainedMinor UpdateN/ADOCComposite release notehttps://git.onap.org/doc/tree/docs/releasehttps://docs.onap.org/en/latest/release/releaserepos.html#doc-releaserepos

Sofia Wallin

MaintainedMinor UpdateN/ADOCONAP User Guideshttps://git.onap.org/doc/tree/docs/guides/onap-userhttps://docs.onap.org/en/latest/guides/onap-user/index.html
Sofia Wallin
MaintainedMinor UpdateN/ADOCONAP Operation Guideshttps://git.onap.org/doc/tree/docs/guides/onap-operatorhttps://docs.onap.org/en/latest/guides/onap-operator/index.html
Sofia Wallin
MaintainedMinor UpdateN/ADOCRST Templateshttps://git.onap.org/doc/tree/docs/templatesSofia WallinDOCDOC Developer Guidehttps://git.onap.org/doc/tree/docs/guides/onap-developer/how-to-use-docshttps://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html
Sofia Wallin
DOCAPI Referencehttps://git.onap.org/doc/tree/docs/guides/onap-developer/apirefhttps://docs.onap.org/en/latest/guides/onap-developer/apiref/index.html
? Chaker Al-Hakim
DOCONAP Tutorialshttps://git.onap.org/doc/tree/docs/guides/onap-developer/tutorialshttps://docs.onap.org/en/latest/guides/onap-developer/tutorials/index.html? DOCONAP Component Document Indexhttps://git.onap.org/doc/tree/docs/guides/onap-developer/developing

https://docs.onap.org/en/latest/guides/onap-developer/developing/index.html

https://git.onap.org/doc/log/docs/conf.py

Sofia Wallin
DOCONAP Architecturehttps://git.onap.org/doc/tree/docs/guides/onap-developer/architecturehttps://docs.onap.org/en/latest/guides/onap-developer/architecture/index.html
? Chaker Al-Hakim
DOCONAP Overviewhttps://git.onap.org/doc/tree/docs/guides/overviewhttps://docs.onap.org/en/latest/guides/overview/index.html? OOMSetup Guide

Sylvain Desbureaux

MaintainedMinor UpdateN/AOOMRelease Notes

Sylvain Desbureaux

MaintainedMinor UpdateN/AEXTAPIArchitecture
Adrian OSullivan
MaintainedNo ChangeN/AEXTAPIOffered APIs
Adrian OSullivan
MaintainedMinor UpdateN/AEXTAPIConsumed APIs
Adrian OSullivan
MaintainedMinor UpdateN/AEXTAPIInstallation

Adrian OSullivan

MaintainedNo ChangeN/AEXTAPIDeveloper Guide

Adrian OSullivan

MaintainedNo ChangeN/AMSBArchitecture
Former user (Deleted)
MaintainedNo ChangeN/AMSBOffered APIs
Former user (Deleted)
MaintainedNo ChangeN/AMSBConsumed APIs
Former user (Deleted)
MaintainedNo ChangeN/AMSBInstallation
Former user (Deleted)
Maintained No ChangeN/AAPPCAPPC Deploymenthttps://git.onap.org/appc/deployment/tree/docshttps://docs.onap.org/projects/onap-appc-deployment/en/latest/index.html#master-indexAPPCAPPC Documentationhttps://git.onap.org/appc/tree/docshttps://docs.onap.org/projects/onap-appc/en/latest/index.html#master-indexAAFApplication Authorization Frameworkhttps://git.onap.org/aaf/authz/tree/docshttps://docs.onap.org/projects/onap-aaf-authz/en/latest/index.html#master-indexAAFSecret Management Servicehttps://git.onap.org/aaf/sms/tree/docshttps://docs.onap.org/projects/onap-aaf-sms/en/latest/index.html#master-indexCLICommand Line interfacehttps://git.onap.org/cli/tree/docshttps://docs.onap.org/projects/onap-cli/en/latest/index.html#master-index

Outdated/not maintained content

In order to keep track of releases and ensure that the documentation is structured well outdated content need to be removed. It is very hard to keep track, support and perform reviews with lots of content that is not longer relevant.

The project suggest to create a wiki page where we keep track outdated links and content that has not been updated during previous releases. This would be a longterm exercise with recurrent sync with the TSC for approval of removing such pages. 

Action points


Date and Time

Time zoneDateTimeParticipants
CETSeptember 30th13:00-16:30

Sofia Wallin (moderator)


EDTSeptember 30th


PSTSeptember 30th


Logistics:

https://zoom.us/j/92987486389?pwd=QUdnMVVjZS83Y0dEalA2Y01UQzhEZz09