2021-02-18 Doc project meeting

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

Attending

@Andreas Geißler @Andrea Visnyei @Ramakrishna GP @Sofia Wallin @Thomas Kulik@Eric Debeau @Timo Perala



Topics, Notes, Status and Follow-Up Tasks



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

PTL election

Any nominations? No nominations yet. To be tracked the upcoming weeks. 

Pending patches

We have a bunch of pending patches, asking everyone to support with reviewing and submitting these proposed improvement. 

Objectives for Honolulu (and onwards)

Jira ticket walkthrough,

type key summary assignee reporter priority status resolution created updated due
Refresh

Invite Jessica to the next meeting for discussion around enabling voting jobs for warnings.

Guilin Maintenance Release 

Still waiting on confirmed date. To be updated in the final version along with possible features changes/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



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?

@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. 

@Aarna Networks

Final review.

Rama presented their project summary.

Feedback,

We need to ensure that we mark or remove outdated/moved content from the wiki





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