On 11/27/18 4:38 PM, Kendall Nelson wrote:
Hello!
For the long version, feel free to look over the etherpad[1].
It should be noted that this session was in relation to the operator section of the contributor guide, not the operations guide, though they should be closely related and link to one another.
Basically the changes requested can be boiled down to two types of changes: cosmetic and missing content.
Cosmetic Changes:
*
Timestamps so people can know when the last change was made to a given doc (dhellmann volunteered to help here)[2]
*
Floating bug report button and some mechanism for auto populating which page a bug is on so that the reader doesn’t have to know what rst file in what repo has the issue to file a bug[3]
This is something probably for openstackdocstheme to have it everywhere. With launchpad, the information on RST file is part of the "Report a bug" process. We do not have an equivelent "Report a bug" process for storyboard that allows prepopulating content - otherwise, we could update openstackdocstheme to pass this on. Andreas
*
Maybe not cosmetic exactly, but it was requested that the entirety of the contributor guide be translated into as many languages as possible (stevenK volunteered to help get the framework setup so that things could be imported into Zanata for translation)[4]
*
Link to source somewhere on the page so those interested in fixing issues that don’t know the repo structure can find and fix issues right away[5]
Missing Content:
*
Links to the docs in the Operator guide (HA guide, etc)[6]
*
A guide to ‘I fixed this bug locally, how do I get it upstream?’[7]
If there are any unclaimed items you are interested in working on, please do! The contributor guide work items are tracked in StoryBoard here[8]!
-Kendall (diablo_rojo)
[1] https://etherpad.openstack.org/p/BER-Contrib-Guide-Ops
[2] https://storyboard.openstack.org/#!/story/2004436
[3] https://storyboard.openstack.org/#!/story/2004437
[4] https://storyboard.openstack.org/#!/story/2004438
[5] https://storyboard.openstack.org/#!/story/2004439
[6] https://storyboard.openstack.org/#!/story/2004441
[7] https://storyboard.openstack.org/#!/story/2004442
[8]https://storyboard.openstack.org/#!/project/openstack/contributor-guide
-- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126 -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter: jaegerandi SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Graham Norton, HRB 21284 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126