Attending

Andreas Geissler Timo Perala Thomas Kulik Eric Debeau Chaker Al-Hakim  Kenny Paul   

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

ArchNav

  • Short presentation of ArchNav functionalities & targets (current, planned)

  by Chaker Al-Hakim

 Kenny Paul Shedule: end of may onboarding done, results until end of august

The Mentorship Program should help to coordinate the required activities needed to find the best solution to integrate the ArchNav itself or similiar functionality (by the means of the Wiki and RTD). The Architecture Subcommitee as well the Doc Team are requested to support this activity.

Regardless how we realize this kind of navigation, we agreed on not to link Wiki content in formal (RTD) documentation.

Further clarification is needed how the automated link generation via JSON objects work in the ArchNav.

  • ? Possible alternatives to ArchNav, Pros and Cons ?

not discussed; expected result of the Mentorship Program


Next Meeting

We agreed to dedicate also the next meeting (april, 22th) to the architechture team and related documentation tasks. Chaker Al-Hakimwill join.

POSTPONED TO NEXT DOC WEEKLY


Architecture documentation tasks

  • Tasks in context of the ONAP release lifecycle
  • Required improvements (e.g. gerrit account?)
  • Required help


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 ("