2020-11-12 Doc project meeting

Upcoming milestones and release planning for docs

Tasks reading up to RC2/Sign-off (19/11) Note: Wait for new date to be confirmed 

Status on reviews? Guilin Documentation

Walkthrough of remaining Jira tickets

Documentation build issues @Thomas Kulik

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

Branching strategy @Sofia Wallin (all doc project)

Bring discussion to the PTL call early Honolulu release cycle.  

Documentation tracking @Thomas Kulik

@David McBride will join to discuss this further. 

Active projects vs maintenance projects. 

Intersphinx mapping @Jessica Gonzalez

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?

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

@Aarna Networks

How to handle pending patches? There are currently 7 and 4 of them are in the doc repo. 

Local environment to write RST files @Eric Debeau

@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