Versions Compared

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>


...

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-M4RC2CLAMPArchitectureMaintainedMinor UpdateN/APOLICYArchitectureMaintainedMinor UpdateN/APOLICYOffered APIsMaintainedMinor UpdateN/APOLICYDevelopment GuideMaintainedMinor UpdateN/AHOLMESArchitectureMaintainedNo ChangeN/AHOLMESOffered APIsMaintainedNo ChangeN/AHOLMESConsumed APIsMaintainedMinor UpdateN/AHOLMESInstallationMaintainedMinor UpdateN/AModelingArchitectureMaintainedMinor UpdateN/AModelingOffered APIsMaintainedMinor UpdateN/AOOFArchitectureMaintainedMinor UpdateN/AOOFOffered APIsMaintainedMinor UpdateN/AOOFRelease NotesMaintainedMinor UpdateN/AVFCOffered APIsMaintainedMinor UpdateN/ASOArchitectureMaintainedMinor UpdateN/ASOOffered APIsMaintainedMinor UpdateN/ASODevelopment GuideMaintainedMinor UpdateN/AVIDRelease NotesMaintainedMinor UpdateN/AVIDSwagger API

ittay , automatically generated

MaintainedNo ChangeN/AVIDUser GuideMaintainedNo ChangeN/AUsecase UIRelease NotesMaintainedMinor UpdateN/AUsecase UIUser GuideMaintainedMinor UpdateN/AUsecase UIInstallation GuideMaintainedNo ChangeN/ASDCArchitectureMaintainedMinor UpdateN/ASDCRelease NotesMaintainedMinor UpdateN/AAAIOffered APIsMaintainedMinor UpdateAAIAAI REST APIMaintainedMinor UpdateAAIRelease NotesMaintainedMinor UpdateIntegrationRelease NotesMaintainedMinor UpdateIntegrationUser Guide including use case documentationMaintainedMinor UpdateIntegrationTest Developer GuideNewInitial PublicationMultiCloudArchitectureMaintainedNo ChangeN/AMultiCloudRESP APIMaintainedNo ChangeN/AMultiCloudUser GuildMaintainedNo ChangeN/AONAP CLIRelease notesMaintainedMinot updatesN/AVNFSDK

release notes

API

MaintainedMinot updatesN/ADCAEArchitectureMaintainedMinor UpdateDCAERelease NotesMaintainedMinor UpdateDCAEOffered API'sMaintainedMinor UpdateDCAEConsumed API'sMaintainedMinor UpdateDCAE

MOD User guide

MaintainedMinor UpdateDCAEDCAE Service ComponentsMaintainedMinor Update on existing components + new Guilin componentsVVPVVP DocumentationMaintainedMinor UpdateN/AVNFRQTSProvider DocsMaintainedMinor UpdateDMAAPArchitecture and UsageMaintainedNo ChangeN/ADMAAPRelease NotesMaintainedMinor ChangeN/APORTALRelease NotesMaintainedMajor UpdateN/ACCSDKCDS User GuideMaintainedMinor updateN/ACCSDKRelease NotesMaintainedMinor updateN/ASDNCOffered APIsMaintainedMinor UpdateSDNCRelease NotesMaintainedMinor UpdateN/ADOCRelease Notes
NameTopic/taskOutcome
  • 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

Date and Time

...

Sofia Wallin (moderator)

...

Updated our Working Review List (Copy of Guilin Documentation (working version for reviews))
release-notes.rsthttps://docs.onap.org/en/latest/release/index.htmlMaintainedMinor UpdateN/ADOCLanding pagehttps://git.onap.org/doc/tree/docshttps://docs.onap.org/en/latest/index.htmlMaintainedMinor UpdateN/ADOCComposite release notehttps://git.onap.org/doc/tree/docs/releasehttps://docs.onap.org/en/latest/release/releaserepos.html#doc-releasereposMaintainedMinor UpdateN/ADOCONAP User Guideshttps://git.onap.org/doc/tree/docs/guides/onap-userhttps://docs.onap.org/en/latest/guides/onap-user/index.htmlMaintainedMinor UpdateN/ADOCONAP Operation Guideshttps://git.onap.org/doc/tree/docs/guides/onap-operatorhttps://docs.onap.org/en/latest/guides/onap-operator/index.htmlMaintainedMinor 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.htmlDOCAPI Referencehttps://git.onap.org/doc/tree/docs/guides/onap-developer/apirefhttps://docs.onap.org/en/latest/guides/onap-developer/apiref/index.htmlDOCONAP Tutorialshttps://git.onap.org/doc/tree/docs/guides/onap-developer/tutorialshttps://docs.onap.org/en/latest/guides/onap-developer/tutorials/index.htmlDOCONAP 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

DOCONAP Architecturehttps://git.onap.org/doc/tree/docs/guides/onap-developer/architecturehttps://docs.onap.org/en/latest/guides/onap-developer/architecture/index.htmlDOCONAP Overviewhttps://git.onap.org/doc/tree/docs/guides/overviewhttps://docs.onap.org/en/latest/guides/overview/index.htmlOOMSetup GuideMaintainedMinor UpdateN/AOOMRelease NotesMaintainedMinor UpdateN/AEXTAPIArchitectureMaintainedNo ChangeN/AEXTAPIOffered APIsMaintainedMinor UpdateN/AEXTAPIConsumed APIsMaintainedMinor UpdateN/AEXTAPIInstallationMaintainedNo ChangeN/AEXTAPIDeveloper GuideMaintainedNo ChangeN/AMSBArchitectureMaintainedNo ChangeN/AMSBOffered APIsMaintainedNo ChangeN/AMSBConsumed APIsMaintainedNo ChangeN/AInstallationMaintained No ChangeN/A
  • Put to TSC agenda to come up with a Release strategy.

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

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

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