[Openstack-operators] Ops Community Documentation - first anchor point
doug at doughellmann.com
Thu May 24 04:23:53 UTC 2018
You will want to follow the steps of the "project creators' guide"
. Not all of them apply, because this is a docs repo and not a
code project repo. Let me know if you have questions about which
pieces do or do not apply as you go along, and we can work on
improving that document as well.
The openstack/tripleo-docs repo looks like it has a setup similar
to the one you'll be creating, so when you get to the steps about
setting up jobs you can probably copy what they have.
After the session today it occurred to me that there is one
governance-related thing that we would need to do in order to publish
this content to docs.openstack.org. Right now we have a policy that
only official teams can do that. I think if the guide is owned by
a SIG or other group chartered either by the TC or UC we can make
that work. We can do quite a lot of the setup work while we figure
that out, though, so don't lose momentum in the mean time.
Excerpts from Chris Morgan's message of 2018-05-23 20:09:05 -0700:
> I hadn’t got that far in my thoughts. If you’re able to give that a go, then that would be great!
> Sent from my iPhone
> > On May 23, 2018, at 6:46 PM, Jonathan D. Proulx <jon at csail.mit.edu> wrote:
> > Thanks for kicking this off Chris.
> > Were you going to create that new repository? If not I can take on
> > the tasks of learning how and making it happen.
> > -Jon
> > On Wed, May 23, 2018 at 06:38:32PM -0700, Chris Morgan wrote:
> > : Hello Everyone,
> > : In the Ops Community documentation working session today in Vancouver,
> > : we made some really good progress (etherpad
> > : here: https://etherpad.openstack.org/p/YVR-Ops-Community-Docs but
> > : not all of the good stuff is yet written down).
> > : In short, we're going to course correct on maintaining the Operators
> > : Guide, the HA Guide and Architecture Guide, not edit-in-place via the
> > : wiki and instead try still maintaining them as code, but with a
> > : different, new set of owners, possibly in a new Ops-focused repo. There
> > : was a strong consensus that a) code workflow >> wiki workflow and that
> > : b) openstack core docs tools are just fine.
> > : There is a lot still to be decided on how where and when, but we do
> > : have an offer of a rewrite of the HA Guide, as long as the changes will
> > : be allowed to actually land, so we expect to actually start showing
> > : some progress.
> > : At the end of the session, people wanted to know how to follow along as
> > : various people work out how to do this... and so for now that place is
> > : this very email thread. The idea is if the code for those documents
> > : goes to live in a different repo, or if new contributors turn up, or if
> > : a new version we will announce/discuss it here until such time as we
> > : have a better home for this initiative.
> > : Cheers
> > : Chris
> > : --
> > : Chris Morgan <mihalis68 at gmail.com>
> > :
> > :References
> > :
> > : 1. https://etherpad.openstack.org/p/YVR-Ops-Community-Docs
> > : 2. mailto:mihalis68 at gmail.com
> > :_______________________________________________
> > :OpenStack-operators mailing list
> > :OpenStack-operators at lists.openstack.org
> > :http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-operators
More information about the OpenStack-operators