Versions Compared

Old Version 2

changes.mady.by.user Guillaume Lambert

Saved on

compared with

New Version 3

changes.mady.by.user Thomas Kulik

Saved on

Key

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

...

TopicNotes / 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.   TASK: evaluate and test    
  •  create Jira ticket to evaluate 0.6.0 for istanbul
  • tox.ini doppelganger:
  •  
 TASK:
  • create Jira ticket for istanbul / cleanup doc first
  • tox.ini , conf.py / linkcheck (INFO: put links in code sections are ! 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,

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. 

  •  Update "Documentation improvements for end to end usage of ONAP"

@Aarna Networks

Call scheduled for Tuesday WW13

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


...