2021-06-17 Doc project meeting

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

Attending

 @Thomas Kulik  @Nicholas Karimi @Kenny Paul @Andrea Visnyei



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

AGENDA FOR TODAY



ArchNav Internship

First: Identify Maintenance Model (who is able to maintain it in production / for all the upcoming releases of ONAP)
Identify the use cases currently applied to ArchNav and use cases for the Doc team's needs
Look at the potential use of LF Landscape 
Look at the potential use of inkscape for a clickable graphic (@Eric Debeau has done a PoC of the functionality)

NOT DONE DUE TO TIME CONSTRAINTS



Open gerrit issues

  • We went through the open gerrit issues for Honolulu (Maintenance)  / Istanbul release

Open jira tickets

  • We went through the open Jira issues for Honolulu (Maintenance)  / Istanbul 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.

Doc Tracking Page

  • Updates

Guide Doc Dev System

  • Released and updated; @Timo Perala volunteers for review.

Upcoming Meetings / Vacations

  • A few previous meetings have been canceled due to vacation, public holidays in germany and the LFN DTF.

  • 17.06.2021 until 25.06.2021: Vacation @Eric Debeau

  • 24.06.2021 until 01.07.2021: Vacation @Thomas Kulik

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.
Copyright notice an RTD still shows the wrong year.
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"

  • open

Documenting ONAP Architecture (New)

Istanbul-R9 Architecture General Description

Istanbul-R9 ONAP Architecture Component Description



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