Open Stack

Looking at what they¹re building for Neutron,
http://docs.openstack.org/networking-guide, they have a quite fine grain
splitting of their guide with a large contents page that helps find things
easily. My personal issues with the current ironic guide all comes down to
navigation, the current Table of contents system is unpleasant to use,
splitting the guide into multiple pages will help this to a degree because
it¹ll reduce the amount of times I end up either using Ctrl-F or scrolling
back to the top to look at the contents, but I think it would be nice to
have a reworked contents page.

As a side note I don¹t know about other people but I prefer the styling of
the Neutron guide, but is that something that we even have a choice in?

Sam

On 14/09/2015 15:00, "Dmitry Tantsur" <dtantsur at redhat.com> wrote:

>On 09/14/2015 03:54 PM, Ruby Loo wrote:
>>
>>
>> On 11 September 2015 at 04:56, Dmitry Tantsur <dtantsur at redhat.com
>> <mailto:dtantsur at redhat.com>> wrote:
>>
>>     Hi all!
>>
>>     Our install guide is huge, and I've just approved even more text for
>>     it. WDYT about splitting it into "Basic Install Guide", which will
>>     contain bare minimum for running ironic and deploying instances, and
>>     "Advanced Install Guide", which will the following things:
>>     1. Using Bare Metal service as a standalone service
>>     2. Enabling the configuration drive (configdrive)
>>     3. Inspection
>>     4. Trusted boot
>>     5. UEFI
>>
>>     Opinions?
>>
>>
>> Thanks for bringing this up Dmitry. Any idea whether there is some sort
>> of standard format/organization of install guides for the other
>> OpenStack projects?
>
>Not sure
>
> > And/or maybe we should ask Ops folks (non developers
>> :-))
>
>Fair enough. I've proposed basic vs advanced split based on what we did
>for TripleO downstream, which was somewhat user-driven.
>
>>
>> --ruby
>>
>>
>> 
>>_________________________________________________________________________
>>_
>> 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
>>
>
>
>__________________________________________________________________________
>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