[Openstack-docs] What's Up Doc? Special Summit Edition Nov 5 2013
Nicholas Chase
nchase at mirantis.com
Tue Nov 5 23:31:01 UTC 2013
On 11/5/2013 6:26 PM, Anne Gentle wrote:
>
>
>
> On Tue, Nov 5, 2013 at 12:37 PM, Nicholas Chase <nchase at mirantis.com
> <mailto:nchase at mirantis.com>> wrote:
>
> Yeah, I think Nermina's right here; both admins and installers need
> the config reference, I would think -- correct me if I'm wrong -- so
> at the very least the parameters need to be extracted into one place
> to be shared by both roles.
>
> Which actually begs the question, do we want to remove all the "how
> to configure" information and put it in the admin guide, since we'll
> then also have to repeat it in the install guide?
>
>
> The install guide should only have a handful of adventures, not all the
> networking and storage use cases. Think happy path for install guide. :)
So an easy, quick install in the install guide, and then you go
elsewhere to find out how to do something more complicated? I'm in.
And then you go to the Admin guide for that more complicated use case?
That works for me.
> Tom's really interested in getting plain reference info - somewhat due
> to the word count the books are getting to, but also due to the original
> vision, which was reference info only in one place. He thinks admins
> configure and tune all the time.
Plain works as long as it's still useful. :)
> Good discussion, thanks a bunch for poking at the ideas!
My pleasure. :) Thanks for starting the discussion!
--- Nick
> Anne
>
> (I know, we're back to the original question, but that is kind of
> the crux of the matter.)
>
> ---- Nick
>
>
> On 11/5/2013 1:32 PM, Diane Fleming wrote:
>
> Keeping it separate is fine – I wasn't aware the config ref was
> for more
> than just the admin role.
>
>
> /Diane/
> /-----------------------------__-----------------/
>
> Diane Fleming
> Software Developer II - US
> diane.fleming at rackspace.com <mailto:diane.fleming at rackspace.com>
> Cell 512.323.6799 <tel:512.323.6799>
> Office 512.874.1260 <tel:512.874.1260>
> Skype drfleming0227
> Google-plus diane.fleming at gmail.com <mailto:diane.fleming at gmail.com>
>
> From: Nermina Miller <nerminamiller at gmail.com
> <mailto:nerminamiller at gmail.com>
> <mailto:nerminamiller at gmail.__com <mailto:nerminamiller at gmail.com>>>
>
> Date: Tuesday, November 5, 2013 12:30 PM
> To: Diane Fleming <diane.fleming at rackspace.com
> <mailto:diane.fleming at rackspace.com>
> <mailto:diane.fleming at __rackspace.com
> <mailto:diane.fleming at rackspace.com>>>
> Cc: Nicholas Chase <nchase at mirantis.com
> <mailto:nchase at mirantis.com> <mailto:nchase at mirantis.com
> <mailto:nchase at mirantis.com>>>,
> "openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>
> <mailto:openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>>"
> <openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>
> <mailto:openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>>>
>
> Subject: Re: [Openstack-docs] What's Up Doc? Special Summit
> Edition Nov
> 5 2013
>
> I like the idea of having the Config Ref be a complete reference
> for all
> roles so it can be maintained in one place and referred to from
> other
> guides, but I think you have more experience with the users to
> be able
> to gauge that. - Nermina
>
>
> On Tue, Nov 5, 2013 at 1:22 PM, Diane Fleming
> <diane.fleming at rackspace.com
> <mailto:diane.fleming at rackspace.com>
> <mailto:diane.fleming at __rackspace.com
> <mailto:diane.fleming at rackspace.com>>> wrote:
>
> Do we need two books?
>
> Can the reference tables be appendices in the Cloud Admin
> Guide, and
> rename that book "Cloud Admin Guide and Reference"?
>
> I'm fine with it either way – though it might be nice to have
> everything in one place given the book isn't too big.
>
> /Diane/
> /-----------------------------__-----------------/
>
> Diane Fleming
> Software Developer II - US
> diane.fleming at rackspace.com <mailto:diane.fleming at rackspace.com>
> <mailto:diane.fleming at __rackspace.com
> <mailto:diane.fleming at rackspace.com>>
> Cell 512.323.6799 <tel:512.323.6799> <tel:512.323.6799
> <tel:512.323.6799>>
> Office 512.874.1260 <tel:512.874.1260> <tel:512.874.1260
> <tel:512.874.1260>>
> Skype drfleming0227
> Google-plus diane.fleming at gmail.com
> <mailto:diane.fleming at gmail.com>
> <mailto:diane.fleming at gmail.__com <mailto:diane.fleming at gmail.com>>
>
> From: Nermina Miller <nerminamiller at gmail.com
> <mailto:nerminamiller at gmail.com>
> <mailto:nerminamiller at gmail.__com
> <mailto:nerminamiller at gmail.com>>>
>
> Date: Tuesday, November 5, 2013 12:18 PM
> To: Nicholas Chase <nchase at mirantis.com
> <mailto:nchase at mirantis.com> <mailto:nchase at mirantis.com
> <mailto:nchase at mirantis.com>>>
> Cc: "openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>
> <mailto:openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>>"
> <openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>
> <mailto:openstack-docs at lists.__openstack.org
> <mailto:openstack-docs at lists.openstack.org>>>
>
> Subject: Re: [Openstack-docs] What's Up Doc? Special Summit
> Edition
> Nov 5 2013
>
> I just wonder what would happen if an install gal/guy needs
> to know
> how to configure something and it's in the Cloud Admin
> Guide instead
> of Config Ref. - Nermina
>
>
> On Tue, Nov 5, 2013 at 1:10 PM, Nicholas Chase
> <nchase at mirantis.com <mailto:nchase at mirantis.com>
> <mailto:nchase at mirantis.com <mailto:nchase at mirantis.com>>>
> wrote:
>
>
>
> On 11/5/2013 12:37 PM, Anne Gentle wrote:
>
>
>
>
> On Tue, Nov 5, 2013 at 10:02 AM, Nicholas Chase
> <nchase at mirantis.com <mailto:nchase at mirantis.com>
> <mailto:nchase at mirantis.com <mailto:nchase at mirantis.com>>
> <mailto:nchase at mirantis.com
> <mailto:nchase at mirantis.com> <mailto:nchase at mirantis.com
> <mailto:nchase at mirantis.com>>>>
>
> wrote:
>
> Restructure:
> Despite the tradeoff that we have to
> re-communicate
> some more
> moves to
> all the teams, we want to trim the
> configuration
> reference down
> to just
> listings of options, no how-to or explanatory
> information. Move this
> type of info to the Cloud Admin Guide. Are
> we good
> with this
> plan for
> Icehouse?
>
>
> Are you suggesting that the Config References just
> lists parameters
> without any explanation of what they mean? I
> agree
> with eliminating
> conceptual or how-to information and moving it
> to cloud
> admin, but
> I'm against removing explanations of what the
> parameters mean/do.
>
>
> No, it'll be a book with just xi:includes of the
> current
> tables. What do
> you think?
>
>
> That makes more sense, as long as it's convenient (read:
> reasonably intuitive) to find the additional
> information for
> those who will need it, regardless of their function.
>
>
> ---- Nick
>
> ___________________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.__opensta__ck.org
> <http://openstack.org>
> <mailto:Openstack-docs at lists.__openstack.org
> <mailto:Openstack-docs at lists.openstack.org>>
> http://lists.openstack.org/____cgi-bin/mailman/listinfo/____openstack-docs
> <http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs>
>
>
> <http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs
> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>>
>
>
>
>
> --
> Thank you!
>
> Nermina Miller
> Tech Writer and Editor
>
>
>
>
> --
> Thank you!
>
> Nermina Miller
> Tech Writer and Editor
>
>
> _________________________________________________
> Openstack-docs mailing list
> Openstack-docs at lists.__openstack.org
> <mailto:Openstack-docs at lists.openstack.org>
> http://lists.openstack.org/__cgi-bin/mailman/listinfo/__openstack-docs
> <http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs>
>
>
>
>
> --
> Anne Gentle
> annegentle at justwriteclick.com <mailto:annegentle at justwriteclick.com>
More information about the Openstack-docs
mailing list