Attending
Thomas Kulik NICHOLAS KARIMI MUIGAI Kenny Paul Andrea Visnyei Andreas Geissler Eric Debeau
| Topic | Notes / Status / Follow-up |
|---|
| |
| ArchNav Internship / SVG ArchMap | - ONAP Web Based Architecture Navigation Solution
- Architecture Navigator page @doc project: Architecture Navigator (ArchNav)
- contribution of NICHOLAS KARIMI MUIGAI 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): |
| Upcoming Meetings / Vacations | - 12.07.2021 until 23.07.2021: Vacation Andrea Visnyei
- next #doc meeting sheduled for 15.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?
|
| Doc Tracking Page | |
| Guide Doc Dev System | - Released and updated; Timo Perala volunteers for review.
|
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
|
T
|
Created
|
Updated
|
Due
|
Assignee
|
Reporter
|
P
|
Status
|
Resolution
|
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
| |
- 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
|
| 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 (" |
