Attending
Topics, Notes, Status and Follow-Up Tasks
Topic | Notes / Status / Follow-up |
---|---|
Upcoming milestones and release planning for docs | Documentation hackathon for Guilin - dates needed Make sure you attend the second doc hackathon scheduled during the event next week. We will focus on reviews |
Status of the ONAP Component Document | see: - DOC-672Getting issue details... STATUS Andreas Geissler |
Discussion about "ONAP Active Project" page | see: - DOC-671Getting issue details... STATUS Andreas Geissler |
Decision on "Tutorials" (see Jira) and Responsibility for "Architecture" RSTs in DOC repository | see: - DOC-673Getting issue details... STATUS Andreas Geissler |
Virtual event | Discussion on session proposed by Thomas Kulik ****** PROPOSAL - TO BE DISCUSSED ****** Impact of the current ONAP release- and branching strategy on documentation. Discussion of the problems and possible solutions. Problem Statement: The Doc team has the responsibility to create an “umbrella document” that is the entry point for ONAP documentation. This file provides all the links to release specific documentation for functional as well for non-functional components. For the Doc team it is currently not clear, which (sub)components are part of a ONAP release. Proposals:
Required Participants:
Duration: 1 hour Comments from Sofia Wallin The heading of the session and the "problem statement" doesn't align to me. Maybe calling it something like "Release requirements for documentation". Some of these proposals are already implemented (such as corresponding milestones) but could probably be improved. Someone need to make sure that we reach out to the people that are asked to participate. Also, I would avoid mentioning branching strategy since this is not a problem to solve for the doc project |
Documentation guide | 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-602Getting issue details... STATUS ) Jakob Krieg : Created ticked about Testing instructions - DOC-651Getting issue details... STATUS |
Update "Documentation improvements for end to end usage of ONAP" @Aarna Networks | MS2 to start next week. Sriram gives an update in TSC meeting following this meeting ****************************************************** 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. |
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 |