Attending

Timo Perala Thomas Kulik Eric Debeau Chaker Al-Hakim  Byung-Woo Jun   Kenny Paul   Andrea Visnyei

Topics, Notes, Status and Follow-Up Tasks


TopicNotes / Status / Follow-up

AGENDA FOR TODAY

Todays meeting is dedicated to have a discussion with the architecture team about related documentation tasks and the Architecture Navigator

Honolulu Release
  • urgent steps to be done to finalize docs for honolulu:

OPEN:

https://gerrit.onap.org/r/c/doc/+/120814
https://gerrit.onap.org/r/c/doc/+/120823

comp rel notes: update release date
arch diagram update

NOT UPDATED TO HONOLULU YET:
https://docs.onap.org/projects/onap-integration/en/latest/release-notes.html#release-notes
https://docs.onap.org/projects/onap-modeling-modelspec/en/latest/Release-notes/release-notes.html#release-notes
https://docs.onap.org/projects/onap-policy-clamp/en/latest/release-notes.html#release-notes
https://docs.onap.org/projects/onap-dmaap-messagerouter-messageservice/en/latest/release-notes/release-notes.html#release-notes
https://docs.onap.org/projects/onap-dmaap-datarouter/en/latest/release-notes.html#release-notes
https://docs.onap.org/projects/onap-dmaap-buscontroller/en/latest/release-notes/release-notes.html#release-notes
https://docs.onap.org/projects/onap-msb-apigateway/en/latest/release-notes.html#release-notes

Vacation / Next Weekly
  • Thomas is one week off cancelled
  • Moderator for the next doc meeting:

Architecture documentation tasks

  • Tasks in context of the ONAP release lifecycle
    • Eric Debeau Can details from the architecture wiki (component diagrams) be transfered to RTD?
    • Chaker Al-Hakimwill bring this up in the next arch call and will discuss with TPL; maybe Eric Debeaucan help with some automation
  • Architecture review process (Wiki → Review → RTD) is implemented and will be used also in upcoming releases
  • Chaker Al-Hakim will give gerrit a chance (to review changes in the future); no new repo required; part of doc/guides
  • Responsibility for API documentation (part of architecture subcommittee?) 
    • Andy Mayerhas proposed a solution to document APIs
    • each PTL is responsible to provide the information
    • doc team must describe how to include the swagger file in rst (as part of the doc guidelines); then the doc shows up correctly in RTD

Refresh for architecture docs


Wiki 2.0 - New Task Force
  • Led by Timo Perala, Ranny Haiby. Goal: Redefine the structure of the ONAP wiki, to identify the relevant pages, to create onboarding for newbies, etc.




OPTIONAL (IF TIME ALLOWS)


All

Collection of topics not started

  • Dedicated repo for every subcommittee (that creates and maintains formal ONAP documentation)? To be discussed.
  • Fix ReadTheDocs starting page to the last official release (and not 'latest')
  • add tracking information to the new docs tracking page (currently WIP!!!) To be discussed.
  • Objectives for Honolulu (and onwards)

Jira ticket walkthrough,

Key Summary T Created Updated Due Assignee Reporter P Status Resolution
Refresh

The team will investigate further with the OOM team on how to enable a non-voting job for warnings. 

  • Check why closes ticket show up even when the filter is set to "Open" or "In progress"
  • Guilin Maintenance Release 

All done for the doc project (date in the release note might need to be updated). Still lacking some project updates

  • Architecture documentation 

For future collaboration and facilitation we will ask for a time slot in the arch subcommittee meeting to inform and educate how to work with docs.

https://gerrit.onap.org/r/c/doc/+/115497

David McBride will join to discuss this further. 

Active projects vs maintenance projects.

A weekly meeting was scheduled to allign doc topics with RelMgr

Many links are managed in RTD

  • local links within a repo
  • inter-project links using inter-links from sphinx
  • links to code repo
  • external links to web sites

There is a problem when a documentation linkes to a repo => the branc is not indicated. As result, the link points to the latest release

Propostion to provide guidelines to be then presented for PTL


Many links are broken => need to include a test in JJB and provide information about broken links

Feedback has been given, positive output. Next step, bring to PTL 

Sill required from the project to test


Create project docs manually with gerrit in case a project has branched but not changed any file in the new branch afterwads

Andreas Geissler showed a solution to create project docs manually within gerrit in case a project has branched but not changed any doc file in the new branch afterwards. There are extended right in gerrit needed ("