2020-09-10 Doc project meeting

Attending

@Thomas Kulik @Andreas Geißler @Eric Debeau @Andrea Visnyei @Ken KANISHIMA @Sofia Wallin

Topics, Notes, Status and Follow-Up Tasks



Topic

Notes / Status / Follow-up

Topic

Notes / Status / Follow-up

Upcoming milestones and release planning for docs

Documentation hackathon for Guilin - dates needed

1st September 30th 

2nd October 14th (preliminary)

Documentation guide 

@Thomas Kulik @Jakob Krieg

@Thomas Kulik : Documentation Developer Guide (https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/index.html) extention planned for Beginners and restructure extisting Guide (DOC-602: Documentation guide refinementClosed)

@Jakob Krieg : Created ticked about Testing instructions DOC-651: Update Guide for Testing One ProjectClosed

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

@Aarna Networks



MS1 close to finished. 

MS2 in review for prioritization (work starting in next 2 weeks) 

Status update page: Documentation improvements for end to end usage of ONAP

An update to the TSC will be done within a couple of weeks.



Review process for docs?

Use the hackathons to start reviewing docs 

check with David which types of documentation that's expected of the doc project to track 

Create a tracking page under the doc wiki space to structure the reviews, suggested to be sorted by components.

@Sofia Wallin to create a working version with a copy from, Guilin Documentation

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