[Openstack-docs] Administration Guide-Design

Anne Gentle annegentle at justwriteclick.com
Wed Jul 3 19:53:15 UTC 2013


Approved. :) Venture forth and break new ground!

Anne Gentle
Content Stacker
anne at openstack.org


On Jul 3, 2013, at 3:09 PM, Sean Roberts <seanrob at yahoo-inc.com> wrote:

> We are almost ready to start posting new training material. I assumed I should I wait until the blueprint is approved... Or not?
> 
> ~sean
> 
> On Jul 3, 2013, at 5:22 AM, "Nick Chase" <nchase at mirantis.com> wrote:
> 
>> A big part of the plan is that modularity so you should be fine , but I will definitely have a look at the training manuals and try not to break anything.
>> On Jul 2, 2013 7:01 PM, "Sean Roberts" <seanrob at yahoo-inc.com> wrote:
>>> We are working on user group driven training material that will need to be horizontal to at least the administrator guides and pull shared material from all in the repo. https://blueprints.launchpad.net/openstack-manuals/+spec/training-manuals
>>> Does this plan align with the different administrator guides below? 
>>> 
>>> ~sean
>>> 
>>> On Jul 1, 2013, at 6:13 PM, "Nicholas Chase" <nchase at mirantis.com> 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.
>>>> 
>>>> 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
> _______________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130703/27c702ca/attachment.html>


More information about the Openstack-docs mailing list