2021-05-06 Doc project meeting

Owned by Thomas Kulik
Last updated: Aug 11, 2021
2 min read

Attending

@Timo Perala @Thomas Kulik @Eric Debeau   @Andreas Geißler

Topics, Notes, Status and Follow-Up Tasks



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

AGENDA FOR TODAY



Open gerrit issues

Open Jira tickets

  • We went through the open Jira issues for Honolulu release

@Thomas Kulik : Propose that every project should use tox.ini (incl. link check)? Create a new Epic for this? conf.py must be updated as well!

Sprints

  • Should we structure our (doc) work in sprints?

@Thomas Kulik : Ask for DT-internal help to set up this structure. @Eric Debeauand @Andreas Geißlerwill help as well.

New Doc Tracking Page

  • Now active for Istanbul release. See 

Guide Doc Dev System

  • Currently under development (txt version available; transfer to rst at 90%); @Timo Perala volunteers for review.

  • 19.05.2021: The reviewed version (ready for submit) can be found here

Upcoming Meetings

  • 13.05.2021: No meeting due to public holiday.

  • 20.05.2021 and 27.05.2021: @Thomas Kulik Vacation. 

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 type created updated due assignee reporter priority 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

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 Geißler 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 ("