2020-11-26 Doc project meeting

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

Reviews:

Status on reviews? Guilin Documentation 

To be continued. 

Templates:

Projects not using the new release notes template: create a Jira ticket asking the project to update their template. If not for Guilin Release then can move it to Honolulu. 

Jira:

Walkthrough of remaining Jira tickets. 4 tickets remaining. All assigned except one related to architecture documentation. To be solved with Catherine how to proceed. 

Branching:

Potential problem: when projects creates a guilin branch for their documentation a build is not triggered. An actual change needs to be started on order for the documentation to build. 

Would an automated Jenkins trigger be possible? To be discussed for future releases. For the Guilin Release this will be done manually on a regular basis. 

Status on the architecture documentation 

The landing page created by the architecture team is still being used after decision in the TSC that this should be removed. What to do? Sofia Wallinto reach out to Catherine. 

Need to clarify with Chaker contents included in the "Navigator" => I propose to add interactive figure in RTD.

• Templates Sofia Wallin

• Documentation build issues Thomas Kulik

Issues with stable branch creating in RTD. 

New feature added by RTD which is causing issues. Jessica Wagantallis 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)

• Documentation tracking Thomas Kulik

David McBride will join to discuss this further. 

• Intersphinx mapping Jessica Wagantall

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. 

• 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

Local environment to write RST files

Eric requests the team to try the instruction before bringing it to the community.

Link management in RTD Eric Debeau