[Starlingx-discuss] Docs team meeting notes 8/29/18

[Jones, Bruce E]

Summary:  We reviewed two main topics today.  One is our release readiness.  We are on track.  Note that many of the documentation stories will result in wiki documents and thus aren't blocking to the code freeze.  The second topic is an on-going discussion about how to share test execution results, with the team leaning toward creating (somehow) a web accessible dashboard that anyone looking for test results can access.

Agenda and notes for the 8/29 call

  *   Review status of stories for the Oct Release and finalize comitted content:
o    https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.docs&tags=stx.2018.10

  *   Process "Validate Inputs" support based on API Reference
o    Email sent to Cindy Xie and team with html and rst version Michael and team has created.
o    Waiting for any other request.

  *   Validation Results
o    "Launchpad" proposal
?  Some ideas around it:
*         1. Most immediate implementation
*         2. Using a platform to "share code, bug reports, translations and ideas" to share results
*         3. Publish automated but Launchpad API research is needed
?  High level steps:
*         1. Create the "script" to upload html files via Launchpad API
*         2. Implement the "script" under our Test infrastructure
o    "OpenStack" proposal
?  Some ideas around it:
*         1. Not sure if current OpenStack infrastructure is meant to handle results since it uses Gerrit as a trigger to build and publish, but if everyone is ok:
*         2. Midterm implementation doc.starlingx.io not in place yet
*         3. Reuse of existing OpenStack Documentation infrastructure, using doc/ directory
*         4. Some effort on translating Xml to Rst, pandoc our friend? https://pandoc.org/
*         5. Publish automated based on Gerrit, same way as Doc, Api-Ref, Api-Guide and Release Notes
?  High level steps for implementation:
*         1. Review pandoc project to see if it helps in the translation, if not create a XML to RST translator
*         2. Implement the "script" to translate into RST format and check in into stx-docs: stx-docs/doc/source/results/...
*         3. Enable doc.starlingx.io infrastructure
o    "Own" Infrastructure
?  How to automatically put html files into doc.starlingx.io?
*         results.starlingx.io
*         doc.starlingx.io/results

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.starlingx.io/pipermail/starlingx-discuss/attachments/20180829/41296392/attachment-0001.html>