[Starlingx-discuss] [docs][meetings] docs team meeting minutes 9/18

Wed Sep 18 22:30:39 UTC 2019

Join us if you have interest in StarlingX docs! We meet Wednesdays, and call logistics are here: https://wiki.openstack.org/wiki/Starlingx/Meetings. Our etherpad is here: https://etherpad.openstack.org/p/stx-documentation.

-- Mike

Current agenda and notes

2019-09-18

  *   All -- reviews in progress --
?  See summary at https://review.opendev.org/#/q/project:starlingx/docs.
?  We have 6 open. Let's take a look to see how we can push these through.
*        https://review.opendev.org/#/c/682761/ -- Apply fixes from feedback on virtual install guides -- Greg reviewed and added comments. Kris addressed. +1 from Greg and +2 from Bruce. Ready to merge.
*        https://review.opendev.org/#/c/682708/ -- Release Note document for StarlingX 2.0 -- Thanks Bill and Bruce! Needs review from the doc team now. Greg and Kris with both review. Once Greg adds +1, Kris will +2.
*        https://review.opendev.org/#/c/682967/ -- Apply fixes from feedback on bare metal install guides -- Ready for Greg to review.
*        https://review.opendev.org/#/c/680787/ tied to https://bugs.launchpad.net/starlingx/+bug/1842993 -- Fix typos for controller-0 install instructions for R2 -- Greg reviewed and added comments to address. For background, see https://drive.google.com/file/d/1XkE-geSUkv6YtOyPjjPxNq8pLYtYw8aD. This will be abandoned, superseded with https://review.opendev.org/#/c/682761/ and https://review.opendev.org/#/c/682708/.
*        https://review.opendev.org/#/c/681850/ -- Initial creation Doc page Navigate Git Code story/2005184 -- This is a first contribution from an OpenStack community member adding a new page for what was a placeholder stub. Looks great. Has +2. Merge? Yes, merged!
*        https://review.opendev.org/#/c/679896/ tied to https://bugs.launchpad.net/starlingx/+bug/1837931 -- Add instructions for remote CLI access to Openstack -- For background, see https://drive.google.com/file/d/1-UulIR8oBFcphl_ov5as2W5-lwtl6Tqfand https://drive.google.com/file/d/1YUKKGsH-LoR_67wQOotiOZHStIziyh7i. This bug is not fully resolved with the current review, but the linked background emails may be enough. Specifically, we need instructions for REST API. Lower priority for now until we get the latest updates on the install/deploy guides merged. Greg will hunt down the REST API calls.

  *   Abraham and all -- bug status -- https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.docs
?  Resolution for all current bugs should be pushed to the R2 docs, not versioned for R3.
?  Current status: 4 bugs open, 1 high priority. 2 of the bugs have open reviews as explained in the previous section.

  *   Mike -- future/planned reviews for installation/deployment guides --
?  A recent code change will impact bare metal use cases (and possibly others).
*        See https://drive.google.com/file/d/1pic5wr_69fJb94-o3JM7U2xKMJ0HpGJZ for details.
*        This is for R3 and should not be rolled into R2 docs. So it will be rolled into the "upcoming release" section.
?  Erich Cordoba Malibran wrote an installation/deployment guide that mostly overlaps with our own.
*        We need to review it to see if we can pull any goodness into our official docs. Greg will review. Could be the starting point for StarlingX in a box.
*        See https://ericho.github.io/2019-09-12-deploy-virtual-starlingx/ and http://lists.starlingx.io/pipermail/starlingx-discuss/2019-September/006059.html for details.

  *   Mike -- report out on any progress or plans for R3 stories --
?  Where we can add the most value right now is to add the stubbed out landing page for https://storyboard.openstack.org/#!/story/2006289. See http://lists.starlingx.io/pipermail/starlingx-discuss/2019-September/006127.html for more info. We've discussed this in the community meeting and on the mailing list. We'll start this after the latest retrofitted changes to the R2 guides merge.
?  Background:
*        R3 release is currently planned for late November or early December.
*        Current doc stories are here. We'll add to this list -- https://storyboard.openstack.org/#!/story/list?tags=stx.docs&tags=stx.3.0 --
*        The community team is tracking top stories. I submitted these two for the doc team -- https://drive.google.com/file/d/1dXFLc6f4d5MA2l7rRBMnfyk4X6wZ07wX

  *   Kris -- persistent URL requested for versioned docs --
?  We currently change the URL as docs are moved from "current" to "archive." See details here -- https://drive.google.com/file/d/1nw__0P_Ezomu7tRYNZ2dxk6B7v9PFGoD.
?  Kris has an initial idea and will walk us through in the meeting today.
*        Rename "current" folder to be the r2_release, still listed on landing page as 'latest'.
*        All releases will be in the release specific folder e.g. r3_release, r4_release.
*        When a new release comes, or a release is archived, its location does not change, we just update the landing page to explain latest/archived.

  *   Mike -- doc change notice from Kristine Bujold at Wind River --
?  See details here: https://drive.google.com/file/d/1rIftNkaX6hmXvl8HGPNesyuHeSMi5EqL/view?usp=sharing
?  This is now task 36688 in https://storyboard.openstack.org/#!/story/2006289.

Action required (AR) summary

Completed ARs are archived here: https://etherpad.openstack.org/p/stx-documentation-files-003

*        <date task was assigned> -- <owner> -- <description + comments>
*        2019-05-15 -- Scott and Abraham -- Review these code and terminology changes impacting user docs -- https://drive.google.com/file/d/1sCB-lrWhDIJLNAGWBt7wJ1_JxY21m71p -- and report back on specific actions required.
*        2019-07-03 -- Mike -- After the installation/deployment landing pages are updated and the applicable wikis are fully deprecated, send a message to the mailing list clarifying where the "single source of truth" is for the latest content -- wiki vs. doc site vs. Gerrit reviews in progress.
*        2019-09-18 -- Greg -- Hunt down REST API specifics needed to close https://bugs.launchpad.net/starlingx/+bug/1837931. For background, see https://drive.google.com/file/d/1-UulIR8oBFcphl_ov5as2W5-lwtl6Tqf and https://drive.google.com/file/d/1YUKKGsH-LoR_67wQOotiOZHStIziyh7i.
*        2019-09-18 -- Greg -- Hunt down Ansible-related updates for the guides.
*        2019-09-18 -- Greg -- Review Erich's contribution at https://ericho.github.io/2019-09-12-deploy-virtual-starlingx/ to see if we need to retrofit anything into our existing guides. Also recommend anything toward "StarlingX in a box."

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