[Openstack-operators] Ops Community Documentation - first anchor point
pkovar at redhat.com
Mon May 28 14:03:41 UTC 2018
On Thu, 24 May 2018 07:19:29 -0700
"Jonathan D. Proulx" <jon at csail.mit.edu> wrote:
> My intention based on current understandign would be to create a git
> repo called "osops-docs" as this fits current naming an thin initial
> document we intend to put there and the others we may adopt from
So, just to clarify, the current plan is for your group to take ownership
of the following docs?
Note that there is also
which you probably want to merge with the ha-guide going forward (or
retire one or the other).
As for naming the repo, this is really up to you, but it should be
something clear and easily recognizable by your audience.
I can help with moving some of the content around, but as Doug pointed out,
a few points about actual publishing need to be clarified first with the
> My understanding being they don't to have this type of
> documentention due to much reduced team size and prefer it live with
> subject matter experts. It that correct? If that's not correct I'm
> not personally opposed to trying this under docs. We'll need to
> maintain enough contributors and reviewers to make the work flow go in
> either location and that's my understanding of the basic issue not
> where it lives.
If you want more reviewers involved, I'd recommended inviting the reviewers
from the docs group.
> This naming would also match other repos wich could be consolidated into an
> "osops" repo to rule them all. That may make sense as I think there's
> significant overlap in set of people who might contribute, but that
> can be a parallel conversation.
> Doug looking at new project docs I think most of it is clear enough to
> me. Since it's not code I can skip all th PyPi stuff yes? The repo
> creation seems pretty clear and I can steal the CI stuff from similar
Might be best to look into how https://github.com/openstack/security-doc is
configured as that repo contains a number of separate documents, all managed
by one group.
> I'm a little unclear on the Storyboard bit I've not done
> much contribution lately and haven't storyboarded. Is that relevant
> (or at least relevent at first) for this use case? If it is I
> probably have more questions.
I'd suggest either having your own storyboard or launchpad project so that
users can file bugs somewhere, and give you feedback. storyboard might be a
better option since all OpenStack projects all likely to migrate to it from
launchpad at some point or another.
More information about the OpenStack-operators