[Openstack-docs] Administration Guide-Design

Tom Fifield tom at openstack.org
Tue Jul 2 01:11:57 UTC 2013


On 02/07/13 11:08, Nicholas Chase wrote:
> 
> 
> On 7/1/2013 8:59 PM, Tom Fifield wrote:
>> Welcome Summer! It's great to have you.
>>
>> So, up until 30 seconds ago when I checked the wiki, I thought I had a
>> good idea of our restructure, which is laid out as:
>> https://wiki.openstack.org/wiki/Blueprint-restructure-documentation
>>
>> On of the points of the restructure was to do away with the current
>> administration guide (eg
>> http://docs.openstack.org/trunk/openstack-compute/admin), because
>> operators found it "exhaustive to the point of being past useless"[1].
>>
>> The aim that I remember was to create a Configuration Reference, which
>> would have much shorter introductions to each of the features in
>> OpenStack, followed by a table of their configuration options
>> automatically generated from code.
>>
>> This was to be accompanied by a User guide, one for end-users of the
>> cloud, and one for Administrators of the cloud (wich much shared 
>> content).
>>
>> However, I now see that "Administration Guide" has been added to the
>> wiki, which has caused me great confusion :)
> 
> Well, there's actually TWO blueprints I'm working on.  One is for the 
> admin guide, and the other is for a plan to let people easily break down 
> the admin guide into more manageable pieces in an automated way, so that 
> it doesn't have to be "exhaustive to the point of being past useless". :)
> 
> PLUS, the plan is for the guide that we DO produce to have the 
> configuration information stripped out and included in the Configuration 
> reference as planned.

I think we need to chat - not sure that our understanding of
Configuration Reference is the same.

> All of that said, I definitely see the confusion between the "Admin 
> User's Guide" and the "Administration Guide", which is part of what has 
> been taking me a little bit longer ...
> 
> I think I need to look at this again.
> 
> ----  Nick
> 
>> Regards,
>>
>>
>> Tom
>>
>> [1]https://bugs.launchpad.net/openstack-manuals/+bug/1110137
>>
>> On 02/07/13 10:45, Nicholas Chase wrote:
>>>
>>> On 7/1/2013 8:06 PM, Summer Long wrote:
>>>> Hi Anne,
>>>> I've been working on OpenStack docs over at Red Hat, and would like to
>>>> help with the OS Admin Guide.
>>>> Can you tell me where I can contribute to its design? Steve Gordon 
>>>> tells
>>>> me that the intent is to consolidate the various component guides?
>>>
>>> Hi, Summer --
>>>
>>> I've actually been pretty quiet here, but I'm currently working on a
>>> plan for this consolidation -- blueprint to be up shortly, I promise! --
>>> would you like to get together sometime this week to chat about how we
>>> might work together on this?
>>>
>>>> I'm new to working with Open Source docs (previously worked with
>>>> proprietary software houses), so am pretty excited about stepping over
>>>> to the light side!
>>>
>>> I can't speak for anyone else, but for me, nice to have you here. :)
>>>
>>> ----  Nick
>>>
>>>> thanks,
>>>> Summer
>>>>
>>>>
>>>> Summer Long
>>>> OpenStack Documentation
>>>> Engineering Content Services
>>>>
>>>> Red Hat Asia Pacific
>>>> Brisbane, Australia
>>>> slong at redhat.com <mailto:slong at redhat.com>
>>>>
>>>>
>>>>
>>>>
>>>> _______________________________________________
>>>> Openstack-docs mailing list
>>>> Openstack-docs at lists.openstack.org
>>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>>>
>>>
>>> _______________________________________________
>>> Openstack-docs mailing list
>>> Openstack-docs at lists.openstack.org
>>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
>>
>> _______________________________________________
>> Openstack-docs mailing list
>> Openstack-docs at lists.openstack.org
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>>
> 
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs




More information about the Openstack-docs mailing list