[Starlingx-discuss] [docs] [meeting] Docs team notes 2020-04-22

[Camp, MaryX]

Hello all,
Here are this week's docs team meeting minutes.
Join us if you have interest in StarlingX docs! We meet on Wednesdays 12:30 PST.

  *   Call logistics: https://wiki.openstack.org/wiki/Starlingx/Meetings
  *   Our tracking Etherpad: https://etherpad.openstack.org/p/stx-documentation

thanks,
Mary Camp
==========

2020-04-22
*        All -- reviews merged since last week:  2
*        All -- bug status -- 7 total, 2 oldies, 5 current

  *   [new ww17]  Debug guide, Install guide typo

  *   [ww16] Kata containers and Build Avoidance (AR Mary compare bug text to existing guide text here: https://docs.starlingx.io/developer_resources/build_guide.html#build-avoidance)

  *   [ww15] Backup & restore procedure info, review here:  https://review.opendev.org/#/c/721772/
*        All -- R4 target content: https://storyboard.openstack.org/#!/story/list?status=active&tags=stx.4.0&project_id=1046

  *   Assignment of R4 doc tasks
?  These stories have no assigned person:
*        https://storyboard.openstack.org/#!/story/2007223 (update build guide w/ layered build info)  Poornima has volunteered for this. Mary assigned her in StoryBoard.
*        https://storyboard.openstack.org/#!/story/2007222 (update dist cloud bare metal install w/ redfish info)  AR Mary check discuss archive, may be covered already? If not ask Tao Liu.
*        https://storyboard.openstack.org/#!/story/2006588 (updates for Dist Cloud)  AR Mary ask Dariush (reference the story) Do we need doc updates?
*        All -- Opens

  *   Poornima Y. N. joined to discuss her doc review to modify the build guide (https://review.opendev.org/#/c/721517/). She also volunteered to write the layered build guide (see StoryBoard assignment above)

  *   Greg brought up the installation guides - are they being used? are they good? Yes and Maybe not good enough...
?  At Shanghai meeting, everyone was using their own cheatsheet install guides -- unclear why they were all different.
?  Definitely a good idea to ping the discussion list about what docs we have and how we can improve them.
?  Mary suggests poll the list after this next wave of improvements with proxy diagram updates and instructions.

  *   Greg had another question: what about the remainder of the doc set? People are raising Launchpads for new features, which is what we want. What about the existing features that aren't documented?
?  How to get a roadmap for documenting the rest of the product, if 40% is covered now. Let's start using the Friday meeting for this topic.
?  Greg & Kris made a list of post-install topics to work on: https://etherpad.openstack.org/p/stx-docs-backlog  This etherpad also links to other lists.
?  How to track what isn't documented? For example, the CLI Commands - we could document each one of them, but is that useful?
?  Another option is the online help - we could start bugging the designers to put more info in the online help and automate that into our documentation set.

  *   Reviews in progress:

  *   Upgrade Kubernetes version (R4 new content) -- Review available: https://review.opendev.org/#/c/712583/
  *   STX IPv6 deployment   https://review.opendev.org/#/c/718302/    AR Mary email Joseph Richard directly and ask him for input.

  *   WIP Docker proxy setup Priority 1 task
?  2 reviews merged:  https://review.opendev.org/#/c/718298/ and https://review.opendev.org/#/c/720252/
?  Mary add pointer to new docker proxy page at the next-higher-level of install guides (similar to the IPv4 note, 1 per Rx folder, see https://review.opendev.org/#/c/718302/)
?  Next review will be for 8 R4 guides.
?  17Apr Discussion about diagrams - want better alignment between Install diags + Docker Proxy (colors, labels, etc) AR Mary look for PPT source
?  Mary follow on AR: Dig deeper into the Install guides -- compare them, look at the ways we reuse text. Are there more ways to streamline?

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