Attending
Eric Debeau Andreas Geißler Timo Perala Ramakrishna GP Andrea Visnyei Sofia Wallin
Topics, Notes, Status and Follow-Up Tasks
...
| Topic | Notes / Status / Follow-up | ||||||||
|---|---|---|---|---|---|---|---|---|---|
|
| Issues with stable branch creating in RTD. New feature added by RTD which is causing issues. Jessica Gonzalezis aware of the issue and will investigate further. Conversation with Jessica: Hi Thomas Kulik. The issue was due to the feature 2020-resolver that readthedocs was randomly testing on some of the ONAP projects. I was able to reach out to them to disable it in all onap projects. However, they mentioned that the new feature will be enabled by default sometime Nov. Hopefully the new feature won't break our builds. Check out my conversation with them in: https://jira.linuxfoundation.org/projects/IT/queues/custom/17/IT-21014
| |||||||
| Release date/sign-off December 3rd Reviews: Status on reviews? Guilin Documentation To be continued. Reminder to everyone to fill in the tracking page Branching: Current status: Issues since not all projects have branched yet. The team are supporting projects and reviewing RTD to ensure we are on track. Many broken links appears, tool available for checking this. Eric suggest to run a test right after the release to start working on fixing this. Also to check with Jessica and Aric if this could be implemented with the build. | ||||||||
| Email sent to Catherine 20/11 Need to clarify with Chaker contents included in the "Navigator" => I propose to add interactive figure in RTD. Eric is working with Chaker to update all figurs for Guilin | ||||||||
| |||||||||
| Document new features missing (functional requirements) for the Guilin release. Scope needs to be added on a TSC level as a requirement. Will be discussed in the TSC call today (10/12) | ||||||||
| To propose having a hands-on hacking session. How to get started and write documentation | ||||||||
| Final task for doc
| ||||||||
| 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. | ||||||||
| Follow up with Jessica. Any news from RTD on feature adding | ||||||||
| Bring discussion to the PTL call early Honolulu release cycle. | ||||||||
| 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 | Done via email Select and compile links from RTD Eric Debeau and Andreas Geißler to look at this and make an assessment for further workSummary report is ongoing. Work is planned to run throughout December. | ||||||||
| Eric Debeau presented local documentation testing. We will document a basic for version for local RST rendering. Further extensions will be available if needed/wanted (such as spell checker + Linter) but this requires a more extensive set of tools. To be presented in the PTL call for feedback. ************************************************************************************ Local environment to write RST files and detect Visual Studio Code IDE + Extensions (Spell Checker + Linter) Automatic preview aligned with ONAP documentation schemes Status Notes: Eric has all information and will put it to Wiki, when he finds the proposed location Sofia Wallin to create a wiki page and send to Eric DOC Local environment to write and test RST files Eric requests the team to try the instruction before bringing it to the community. | ||||||||
| Many links ara managed in RTD
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 |
...