[OpenStack-docs] Installation guides for Juno

Matt Kassawara mkassawara at gmail.com
Mon Jul 11 15:46:31 UTC 2016


So, what I'm picking up here...

1) Determine the projects that provide common configuration for most
services (e.g., keystone-middleware, oslo.messaging, etc.) and work with
them to develop and/or improve documentation that projects automatically
consume to generate documentation and/or example configuration files. Gate
jobs should also use the appropriate configuration for a particular release.

2) The installation guide (unintentionally) provides configuration not
available in any other documentation. We should probably add and/or move
such content to another guide more appropriate for existing operators. If
this configuration particularly applies to upgrades, we should determine
why our current documentation (mostly the configuration reference and
release notes) fails to meet expectations.

On Mon, Jul 11, 2016 at 9:33 AM, Edgar Magana <edgar.magana at workday.com>
wrote:

> Inline.
>
>
>
> *From: *Matt Kassawara <mkassawara at gmail.com>
> *Date: *Monday, July 11, 2016 at 8:31 AM
> *To: *Edgar Magana <edgar.magana at workday.com>
> *Cc: *Lana Brindley <openstack at lanabrindley.com>, "
> openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org>
> *Subject: *Re: [OpenStack-docs] Installation guides for Juno
>
>
>
> The configuration reference should include the majority of changes between
> releases... plus release notes for recent releases. Of course, some
> projects *still* don't produce useful operator documentation, such as
> keystone-middleware which often requires some level of reverse engineering
> (often going against the example configuration and help strings) to
> configure the correct way. We could also work around the latter by adding
> some sort of content to the administrator guide that covers common
> configuration for each service.
>
>
>
> I second the idea!  Thanks.
>
>
>
> Edgar
>
>
>
> On Mon, Jul 11, 2016 at 9:26 AM, Edgar Magana <edgar.magana at workday.com>
> wrote:
>
> I do agree BUT sometimes we want to compare the old configuration with the
> new one in order to understand what will be required for new deployments
> versus previous staff. Then, we can adjust our configuration management
> tools.
>
>
>
> Edgar
>
>
>
> *From: *Matt Kassawara <mkassawara at gmail.com>
> *Date: *Monday, July 11, 2016 at 8:25 AM
> *To: *Edgar Magana <edgar.magana at workday.com>
> *Cc: *Lana Brindley <openstack at lanabrindley.com>, "
> openstack-docs at lists.openstack.org" <openstack-docs at lists.openstack.org>
>
>
> *Subject: *Re: [OpenStack-docs] Installation guides for Juno
>
>
>
> The primary audience of the installation guide involves potential new
> operators/users who should begin with the latest release, or at least a
> supported release. Existing operators with production deployments should
> probably avoid the installation guide because it only includes minimal
> configuration for each service.
>
>
>
> On Mon, Jul 11, 2016 at 9:16 AM, Edgar Magana <edgar.magana at workday.com>
> wrote:
>
> Our team still uses some of that documentation   :-(    (Seriously)
>
>
>
> Edgar
>
>
>
> *From: *Matt Kassawara <mkassawara at gmail.com>
> *Date: *Sunday, July 10, 2016 at 4:52 PM
> *To: *Lana Brindley <openstack at lanabrindley.com>
> *Cc: *"openstack-docs at lists.openstack.org" <
> openstack-docs at lists.openstack.org>
> *Subject: *Re: [OpenStack-docs] Installation guides for Juno
>
>
>
> Looks like we need to do some deletions so Google can't find those pages.
>
>
>
> On Sun, Jul 10, 2016 at 5:05 PM, Lana Brindley <openstack at lanabrindley.com>
> wrote:
>
> Let's kill icehouse first. Stats: http://i.imgur.com/I6n88pm.png
> <https://urldefense.proofpoint.com/v2/url?u=http-3A__i.imgur.com_I6n88pm.png&d=CwMFaQ&c=DS6PUFBBr_KiLo7Sjt3ljp5jaW5k2i9ijVXllEdOozc&r=G0XRJfDQsuBvqa_wpWyDAUlSpeMV4W1qfWqBfctlWwQ&m=AYMqHLqSJEg5ZysLVu67_txigkqua7PvFbbJjLJJx7M&s=FOyAAKq53m-AE_OkW07qA8e0OWhYxwCQ_0ifTiFFTAY&e=>
>
> L
>
> On 09/07/16 00:46, Matt Kassawara wrote:
> > Can we get rid of the installation guides for Juno yet?
> >
> >
> > _______________________________________________
> > OpenStack-docs mailing list
> > OpenStack-docs at lists.openstack.org
> > http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> <https://urldefense.proofpoint.com/v2/url?u=http-3A__lists.openstack.org_cgi-2Dbin_mailman_listinfo_openstack-2Ddocs&d=CwMFaQ&c=DS6PUFBBr_KiLo7Sjt3ljp5jaW5k2i9ijVXllEdOozc&r=G0XRJfDQsuBvqa_wpWyDAUlSpeMV4W1qfWqBfctlWwQ&m=AYMqHLqSJEg5ZysLVu67_txigkqua7PvFbbJjLJJx7M&s=gb5z2lAao1oebvFZWXbnNuDTSUpYu1uL2kexNyfu3S8&e=>
> >
>
> --
> Lana Brindley
> Technical Writer
> Rackspace Cloud Builders Australia
> http://lanabrindley.com
> <https://urldefense.proofpoint.com/v2/url?u=http-3A__lanabrindley.com&d=CwMFaQ&c=DS6PUFBBr_KiLo7Sjt3ljp5jaW5k2i9ijVXllEdOozc&r=G0XRJfDQsuBvqa_wpWyDAUlSpeMV4W1qfWqBfctlWwQ&m=AYMqHLqSJEg5ZysLVu67_txigkqua7PvFbbJjLJJx7M&s=w68719XO3Gk4Pnv1ZCS_Ce_tQFdckqutf_gSBilTXDE&e=>
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> <https://urldefense.proofpoint.com/v2/url?u=http-3A__lists.openstack.org_cgi-2Dbin_mailman_listinfo_openstack-2Ddocs&d=CwMFaQ&c=DS6PUFBBr_KiLo7Sjt3ljp5jaW5k2i9ijVXllEdOozc&r=G0XRJfDQsuBvqa_wpWyDAUlSpeMV4W1qfWqBfctlWwQ&m=AYMqHLqSJEg5ZysLVu67_txigkqua7PvFbbJjLJJx7M&s=gb5z2lAao1oebvFZWXbnNuDTSUpYu1uL2kexNyfu3S8&e=>
>
>
>
>
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160711/7616ad13/attachment.html>


More information about the OpenStack-docs mailing list