...
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:
Status Notes:
| ||||||||||||||||
Discussion about "ONAP Active Project" page | see:
Status Notes:
| ||||||||||||||||
Decision on "Tutorials" (see Jira) and Responsibility for "Architecture" RSTs in DOC repository | see:
Status Notes:
| ||||||||||||||||
Virtual event | Discussion on session proposed by Thomas Kulik Event sheduleschedule: https://teamup.com/ksgw6qzqcmg9zbzsfq?view=MD&date=2020-10-13&filterby=8227782,8310614,8310707&viewstate=%7B%22number%22%3A3%7D ****** 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 (example) . 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 Status Notes:
| ||||||||||||||||
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 (
Jakob Krieg : Created ticked about Testing instructions
Status Notes: No further updates | ||||||||||||||||
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. Status Notes:
| ||||||||||||||||
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 |