[openstack-dev] [docs] Our Install Guides Only Cover Defcore - What about big tent?

Hayes, Graham graham.hayes at hpe.com
Wed Mar 23 16:19:24 UTC 2016

On 23/03/2016 16:12, Steve Gordon wrote:
> ----- Original Message -----
>> From: "Steve Gordon" <sgordon at redhat.com>
>> To: "OpenStack Development Mailing List (not for usage questions)" <openstack-dev at lists.openstack.org>
>> ----- Original Message -----
>>> From: "Graham Hayes" hayes at hpe.com>
>>> To: "OpenStack Development Mailing List (not for usage questions)"
>>> <openstack-dev at lists.openstack.org>
>>> On 23/03/2016 15:37, Steve Gordon wrote:
>>>> ----- Original Message -----
>>>>> From: "Mike Perez" <thingee at gmail.com>
>>>>> To: "OpenStack Development Mailing List"
>>>>> <openstack-dev at lists.openstack.org>
>>>>> Hey all,
>>>>> I've been talking to a variety of projects about lack of install guides.
>>>>> This
>>>>> came from me not having a great experience with trying out projects in
>>>>> the
>>>>> big
>>>>> tent.
>>>>> Projects like Manila have proposed install docs [1], but they were
>>>>> rejected
>>>>> by the install docs team because it's not in defcore. One of Manila's
>>>>> goals
>>>>> of
>>>>> getting these docs accepted is to apply for the operators tag
>>>>> ops:docs:install-guide [2] so that it helps their maturity level in the
>>>>> project
>>>>> navigator [3].
>>>>> Adrian Otto expressed to me having the same issue for Magnum. I think
>>>>> it's
>>>>> funny that a project that gets keynote time at the OpenStack conference
>>>>> can't
>>>>> be in the install docs personally.
>>>> Just two minor clarifications here:
>>>> * Manila install docs are actively being worked on for inclusion in the
>>>> Mitaka version of the guide:
>>>> http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide/source/manila.rst
>>>> * Magnum install docs were only very recently proposed here -
>>>> https://review.openstack.org/#/c/288580/ - nobody is saying they can't be
>>>> in the install guide assuming someone is willing to write/maintain them,
>>>> but until now it wasn't clear anyone was.
>>>> I certainly think a better system for linking out-of-tree install docs
>>>> for
>>>> big tent projects would be worth pursuing, but regardless of where it
>>>> lives someone still has to write/maintain that user-orientated content.
>>>> For those that have someone actively doing this on an ongoing basis they
>>>> already have a path to inclusion in the guide (or at least, it seems that
>>>> way based on the cases I am familiar with like those above).
>>>> Are there examples of projects that have this user orientated install
>>>> documentation written but are actively being rejected from including it
>>>> in
>>>> the install guide (in the Magnum case it has been pushed out to Newton as
>>>> it was a late submission, not rejected permanently)?
>>> the linked review - https://review.openstack.org/#/c/213756/
>> Did you look at the link I provided above?:
>> http://git.openstack.org/cgit/openstack/openstack-manuals/tree/doc/install-guide/source/manila.rst
>> This content is merged.
>> -Steve
> Here is the Mitaka spec review for the proposal to add Magnum to the guide: https://review.openstack.org/#/c/275200/
> Here is the Mitaka review to add the Magnum content to the guide: https://review.openstack.org/#/c/273724/

And as I said, if this has changed, that is great.

At the last time I checked docs were def-core only.

> -Steve
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

More information about the OpenStack-dev mailing list