Versions Compared

Key

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

Attending

...

TopicNotes / Status / Follow-up
  •  Objectives for Honolulu (and onwards)

Jira ticket walkthrough,

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


Sofia Wallin to invite Jessica to the next meeting for discussion around enabling voting jobs for warnings.

  •  Guilin Maintenance Release 
  •  February virtual event

Targeted audience new comers. To propose having a hands-on hacking session. How to get started and write documentation. Owner Eric Debeau

Targeted audience All. Improvements made by the docs team. see https://wiki.lfnetworking.org/display/LN/2021+February+Developer+Topic+Proposals#id-2021FebruaryDeveloperTopicProposals-ONAPDocumentationImprovementsandPlans Owner Andreas Geißler

  •  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


  •  Documentation build issues 

Follow up with Jessica. Any news from RTD on feature adding. 

When the build jobs are failing on RTD can we get feedback in Jenkins?

Feedback from Wednesday meeting with the OOM team.

Further discussion will be held. Nothing concrete defined as of now. 

David McBride will join to discuss this further. 

Active projects vs maintenance projects. 

Problem statement:

The conf.py with the intersphinx mapping has different settings/configurations. Some projects refer to the latest branch and some stable/Frankfurt. 

After migrating we did see that some projects refers to latest even when choosing Frankfurt on RTD. Could this be because of the configuration or is the configuration based on whether the projects have created a release branch or not?

Sofia Wallin  From what I learned from Aric, we do not need to change the branch in each repo whenever a project creates their branch. The branch= foo in the conf.py only applies to the default rtd theme, it doesn't do anything for the theme ONAP is using. 

All projects need to have build the stable branch before we can switch the main doc to be the next release branch. 

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

@Aarna Networks

We submitted and cherry picked the final patches. Sent an email to the team to get the tutorials published on RTD according to the decision taken in December.

These 3 should be moved to the ONAP user guide section as an rst file,

https://wiki.onap.org/display/DW/vFWCL+Design+Tutorial

https://wiki.onap.org/display/DW/ONAP+Service+Design+%28vFW%29+Tutorial

https://wiki.onap.org/display/DW/ONAP+Service+Deployment+%28vFW%29+Tutorial

 

But the AWS specific tutorial will remain on the wiki,

https://wiki.onap.org/display/DW/Instructions+for+K8S+cluster+setup+on+AWS



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


...