Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

TopicNotes / Status / Follow-up

New Documenation Tracking Page (Work in Progress!)

https://wiki.onap.org/x/QoIDBg


Eric DebeauStatus Composite Release Note
Status Honolulu Branch for DOC Project
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 discused.
  •  Objectives for Honolulu (and onwards)

Jira ticket walkthrough,

Jira Legacy
serverSystem Jira
jqlQueryproject = DOC AND status = Open
serverId4733707d-2057-3a0f-ae5e-4fd8aff50176

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

...