2020-11-05 Doc project meeting

Owned by Sofia Wallin
Last updated: Nov 11, 2020
2 min read

Attending

@Jessica Gonzalez @David McBride @Andreas Geißler @Timo Perala @Ken KANISHIMA @Andrea Visnyei

Topics, Notes, Status and Follow-Up Tasks





Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

Upcoming milestones and release planning for docs

Tasks reading up to RC2/Sign-off (19/11)

Status on reviews?

Walkthrough of remaining Jira tickets

Status of the ONAP Component Document  

see: DOC-672: Update ONAP component document listClosed Copy of Guilin Documentation (working version for reviews) @Andreas Geißler

Status Notes: 

  • Name of the page should be updated

Discussion about "ONAP Active Project" page

see: DOC-671: ONAP Active Projects vs. ONAP ComponentsClosed @Andreas Geißler

Status Notes: 

  • Agreement: "ONAP Active Projects" will be removed

  • "ONAP components and functionalities" will be updated

Decision on "Tutorials" (see Jira) and Responsibility for "Architecture" RSTs in DOC repository

see: DOC-673: Remove outdated "Tutorials" pageClosed @Andreas Geißler

Status Notes: 

  • "Tutorials" will be removed

  • Agreement, that DOC pages "Architecture", "API Reference" and "ONAP Overview" should be maintained by the Architecture Subcommitee (with support from Eric)

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



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