2021-04-01 Doc project meeting

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

Attending

@Andreas Geißler @Timo Perala @Thomas Kulik @Eric Debeau   @Guillaume Lambert   @Kenny Paul

Topics, Notes, Status and Follow-Up Tasks



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

   @Guillaume Lambert  

Presentation of improvements on ONAP doc files and toolchain (see also related Jira tickes) done by Guillaume:

  • requirements.txt / sphinxcontrib-needs 0.6.0.   

create Jira ticket to evaluate 0.6.0 for istanbul

  • tox.ini doppelganger

create Jira ticket for istanbul / cleanup doc first

  • tox.ini , conf.py / linkcheck (INFO: put links in code sections! this is good practice and links will be ignored at linkcheck)

  • requirements.txt useless entries removed

  • spellcheck: local only, PyEnchant as a alternative (see oom https://gerrit.onap.org/r/c/oom/+/117309)

  • autopep8 linter to beautify code in conf.py 

GREAT WORK! Thank you very much!

Objectives for Honolulu (and onwards)

Jira ticket walkthrough,

type key summary assignee reporter priority status resolution created updated due
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 ara 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 ("