/
2021-07-15 Doc project meeting

2021-07-15 Doc project meeting

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

Attending

 @Nicholas Karimi @Kenny Paul @Andreas Geißler @Eric Debeau  @Thomas Kulik



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

AGENDA FOR TODAY



ArchNav Internship / SVG ArchMap

  • ONAP Web Based Architecture Navigation Solution

  • Architecture Navigator page @doc project: Architecture Navigator (ArchNav)

  • contribution of @Nicholas Karimi currently scheduled until the end of July 2021

  • Ultimate goal is to have a good structure to get information easily findable.

  • ArchNav is used also in the process of architecure reviews and holds additional information about ONAP uses cases

  • POC/Proposal for a architecture map natively designed in Inkscape has started. The SVG format has capabilities to add links, additional text and mouse-over effects to elements. Presentation in the ARC subcommittee meeting as well in the TSC are planned.

  • The idea is that this SVG-map is handed over to architecture team to be maintained in the future. Also it is planned to use it in RTD for a user-friendly entry-point for navigation.

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)

Architecture Documentation in RTD

There is the need to move finalized ONAP architecture documentation from DevWiki to RTD. Especially the following section are from interest (examples from the Istanbul release):

@Andrea Visnyeito support the process of transferring the information from DevWiki to RTD
@Thomas Kulikto support here and check how this process can be automated. Especially the embedded draw.io diagrams (special confluence macro) may cause problems if we use confluence2md to export pages). Shedule a meeting with @Chaker Al-Hakimand team.
@Chaker Al-Hakimand team to support the transfer.
@Chaker Al-Hakim, @Thomas Kulikand teams to create a process to transfer information to RTD also for upcoming releases.

Backlog Clean/Sort/Reorder

do it in jira!

Issue with RTD TOC

check RTD TOC for https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/templates.html

Doc Templates

@Andrea Visnyei and @Andreas Geißler to check current component template and improve if needed

API Documentation

@Kenny Paul , @Eric Debeau Session with @Andy Mayer  needed to clarify how we continue on the API documentation (swagger). The API docs are part of the ARC docs. See also in DevWiki.
@Nicholas Karimi join Kenny in the discussion with @Andy Mayer .

See also in Swagger in RTD

Doc Guideline

Ask users to add always the original file of grafics to the repo (plus the bitmap version of course which is used in wiki/RTD)

Istanbul Release

#doc team: Review Istanbul release notes and project content; extra session required; to be planned.

Vacations & Upcoming Meetings

  • 12.07.2021 until 23.07.2021: Vacation @Andrea Visnyei

  • next #doc meeting sheduled for 22.07.2021

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.





Guide Doc Dev System

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')
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"
Honolulu Maintenance Release 

  • open

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.
Discuss with architecture team, how the following docs can be transfered to RTD:
see:

Documenting ONAP Architecture (New)

Istanbul-R9 Architecture General Description

Istanbul-R9 ONAP Architecture Component Description



Link management in RTD @Eric Debeau

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





Related content