AttendingAttending
Andy Mayer Andreas Geißler Thomas Kulik Andrea Visnyei Ramakrishna GP Ken KANISHIMA Sofia Wallin
Topics, Notes, Status and Follow-Up Tasks
...
| Topic | Notes / Status / Follow-up | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Upcoming milestones and release planning for docs We walked through all Jira tickets for Guilin release. Please keep adding tasks as they occur. Sofia Wallin to invite Andy Mayer to next weeks meeting to get an status update on the work with API documentation. Thanks to Andreas who managed the maintenance releases for ElAlto and Frankfurt. **************************************************** | To be finalized Guilin Release Planning for docs Sofia to add the basics of the documentation project as well as specific. The team will elaborate on their specific areas/content for more details. Encouraging everyone to add planned documentation updates to the documentation tracking page https://wikilf-onap.onapatlassian.org/x/_LkLBQnet/wiki/x/ubT6 | ||||||||||||||||||
| API documentation Andy Mayer | Update regarding API documentation handling. REQ-386
wiki link for instruction Developing ONAP API Documentation Andy to check with Eric and Adrian if they have a template in place? Moving forward we would move the instruction and template to the official documentation guide on RTD. Notes from earlier meeting, Andy Mayer to capture non-functional requirements for Guilin in Jira, create an Epic in the doc project with associated task for each component. He will also support with updating the documentation guide with a swagger instruction. | ||||||||||||||||||
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
| ||||||||||||||||||
Update "Documentation improvements for end to end usage of ONAP" @Aarna Networks | Suggested to create a wiki page to visualise the progress of the project. Also to add other relevant information such as milestone plan and the finial SOW. Sofia Wallin to create a wiki DONE Documentation improvements for end to end usage of ONAP ****************************************************************** Ramakrishna GP Users guide, Operations Guide analysed. Tickets raised and changeset created
| New RST Sphinx extention for CDS Guide | CDS Guide in Confluence uses "Tabs" (see Modeling Concepts) Jakob helps the CDSproject He adds it to the conf.py in the CDS repo. When we successfully use this plugin, a suggestion would be to create a presentation for the TSC/PTL call to promote all tools and extentions in RTD to gain more acceptance to write RTD documents. Possible content: | ||||||||||||||||
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 |
...