[Starlingx-discuss] [docs][meetings] docs team meeting minutes 2019-10-02

Wed Oct 2 21:50:12 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-10-02

  *   Mike -- welcome Mary Camp to the doc team --

  *   All -- reviews in progress and recent merges --
§  See summary at https://review.opendev.org/#/q/project:starlingx/docs.
§  Recent merges. Great job team!
·        https://review.opendev.org/#/c/686036/ -- Fix error in AIO-SX baremetal install guide closing bug #1845139 -- MERGED
·        https://review.opendev.org/#/c/685863/ -- Add new sections to Ansible bootstrap configs -- MERGED
·        https://review.opendev.org/#/c/685470/ -- Update Ansible bootstrap info for clarity -- MERGED
·        https://review.opendev.org/#/c/685179/ -- Implement persistent URLs in versioned docs -- MERGED
·        https://review.opendev.org/#/c/684857/ -- Update install guides landing page -- MERGED
·        https://review.opendev.org/#/c/684852/ -- Minor updates to R2 install section -- MERGED
·        https://review.opendev.org/#/c/684148/ -- Improve readability of install guides R2 -- MERGED
§  We have 2 open. Let's take a look to see how we can push these through.
·        https://review.opendev.org/#/c/679896/ tied to https://bugs.launchpad.net/starlingx/+bug/1837931 -- Add instructions for remote CLI access to Openstack -- This bug is not fully resolved with the current review, but we now have what we need in https://drive.google.com/file/d/1yOK2jQ1ozUNtneObv87CVPajqCVGNkBC/.  Kris will retire https://review.opendev.org/#/c/679896/ and create a new review for the REST API. Erich's CLI contribution is now under https://storyboard.openstack.org/#!/story/2006289 as subtask 36280.
·        https://review.opendev.org/#/c/684820/ -- Introduction editorial updates -- This is Mary's sandbox for Gerrit familiarity and is set to workflow -1 on purpose. No urgency.

  *   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: 3 bugs open, 1 high, 1 med, 1 low.
§  https://bugs.launchpad.net/starlingx/+bug/1844656 -- Kris will verified that https://review.opendev.org/#/c/682967/ should have fixed it, but then there were a bunch of follow-on comments that we need to look at again. Kris/Mary will open a review to address comment #7 in the launchpad.
§  https://bugs.launchpad.net/starlingx/+bug/1837931 -- Greg has provided the content for the bug fix. Thanks greg! See https://drive.google.com/file/d/1yOK2jQ1ozUNtneObv87CVPajqCVGNkBC/.
§  https://bugs.launchpad.net/starlingx/+bug/1835207 -- Abraham will ask for help in the community meeting to get this closed.

  *   Mike -- update to misc. guides --
§  The contributor guide at https://docs.starlingx.io/contributor/doc_contribute_guide.html needs another look. KM will address.
§  Do we need versioned build guides? See https://drive.google.com/file/d/1qeVdyQJ0GlmGzmcIhJtDpKVrdfYiN3ZS. After team discussion and line-by-line comparison, we see that likely no versioning is required. We'll try to close before R3 so we don't unnecessarily create a versioned build guide for R3.

  *   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. This fits into the "gap" discussion from community.
§  We need to get more help from the community. In the meeting this morning, they suggested we provide an explicit "top 5" list as an invitation. This should be stories or sub-tasks of stories. Kris, Mary, and Mike will meet offline to refine this list and link to stories:
·        Distributed Cloud
·        GPU Kubernetes Plugin
·        TSN
·        Redfish
·        Infrastructure and cluster
§  Background:
·        R3 release is currently planned for early December.
·        Current R3 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

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 -- 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-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."
·        2019-10-02 -- Kris -- Retire https://review.opendev.org/#/c/679896/ and create a new review for the REST API to close https://bugs.launchpad.net/starlingx/+bug/1837931 using Greg's info at https://drive.google.com/file/d/1yOK2jQ1ozUNtneObv87CVPajqCVGNkBC/.
·        2019-10-02 -- Kris/Mary -- Open a review to address comment #7 in https://bugs.launchpad.net/starlingx/+bug/1844656.
·        2019-10-02 -- Abraham -- Ask for help in the community meeting to get https://bugs.launchpad.net/starlingx/+bug/1835207 closed.
·        2019-10-02 -- Kris, Mary, Mike -- Meet Monday to refine R3 stories, especially the subtasks for the new config guide. Also finish identifying the top 5 areas where the community could help us.

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