2022-04-21 Doc project meeting

Attending

 @Thomas Kulik @Andreas Geißler @Eric Debeau 



Topics

Notes / Status / Follow-up

Topics

Notes / Status / Follow-up

Meeting Notes

  • Status of Contributions/Contributors: People and contributions are required.

  • Vacation/Release of Jakarta

    • @Eric Debeau to create the composite release notes for Jakarta

  • Current Release Status

    • @Cédric Ollivier Thank you for all your support. Cedric created a large list of patches which is waiting to be processed by projects.

  • Supercommitter / Self-Submit

    • supercommitter is not sufficient here (needs vote from another person which is not always possible in doc team)

  • @Andreas Geißler presented the idea to create a new doc section in RTD which holds information for all projects about used databases, how to create and access them (ui, api); requires a rst-template to be filled by the projects on a regular base (like release notes); interesting especially for the usage in the (DT) portal (which is planned to be released to the public); the information should reside in the (to be updated) template for architecture documentation.

Important Topics for 2022

  • Definition of ONAP Core/MVP/Most valuable Uses Cases required to focus on most important areas (docs, dependencies)

  • Increase number of contributors and contributions in the #doc project

  • Gain knowledge about dependencies between ONAP components and use cases incl. tooling

  • Cleaning up current documentation (remove docs if unmaintained projects are mentioned; update E2E docs, e.g. install)

Doc Procedures

Architecture Documentation in RTD

  • @Gergely Csatari presented results to Architecture Subcommittee @Chaker Al-Hakim and doc team

  • @Chaker Al-Hakim : Wiki is needed to work on architecture documents in a collaborative way. It took up to 2 years to create the architecture template and convince the PTL to use it. Changing the template and process again should be avoided. PTL are the owner of this doc. ArcSubcommittee can not take the efforts to convert all the pages.

  • @Gergely Csatari / @Eric Debeau : But in other Open Source projects it is also possible to work (also on documentation) in a collaborative way but with using rst format and version management like git.

  • @Thomas Kulik If we need to keep the source document in the wiki, we need a 100% automated solution to create a rst file from wiki content per release. But this currently does not seems possible with the evaluated tools and processes.

  • Result: still open, unfortunately



Backlog Clean/Sort/Reorder

open

API Documentation

open

Upcoming #doc Meetings

Topics planned:

  • -

Date:

  • 2022/03/??

Vacations

  • @Andreas Geißler  Vacation:

  • @Eric Debeau Vacation:

  • @Cédric Ollivier Vacation:

  • @Timo Perala  Vacation:

  • @Thomas Kulik Vacation: 06.05.2022 - 27.05.2022