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
2019-09-18
§
See summary at https://review.opendev.org/#/q/project:starlingx/docs.
§
We have
·
https://review.opendev.org/#/c/682761/ -- Apply fixes from feedback on virtual install
guides -- Greg reviewed and added comments
·
https://review.opendev.org/#/c/682708/ -- Release Note document for StarlingX 2.0 --
Thanks Bill and Bruce! Needs review from the doc team now.
·
·
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.
·
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?
·
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.
§
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.
§
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.
·
his
is for R3 and should not be rolled into R2 docs.
§
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.
·
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.
§
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.
§
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
§
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.
§
See details here: https://drive.google.com/file/d/1rIftNkaX6hmXvl8HGPNesyuHeSMi5EqL/view?usp=sharing
§
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.
·
·
·