[OpenStack-docs] Fwd: Re: [openstack-dev] [docs] Our Install Guides Only Cover Defcore - What about big tent?

Andreas Jaeger aj at suse.com
Mon Apr 4 20:09:07 UTC 2016


For those that are not on openstack-dev, I suggest to read the whole
thread there as well.

I've put up a draft proposal and look forward to your comments - and
counter proposals ;)

Andreas


-------- Forwarded Message --------
Subject: Re: [openstack-dev] [docs] Our Install Guides Only Cover
Defcore - What about big tent?
Date: Mon, 4 Apr 2016 20:41:52 +0200
From: Andreas Jaeger <aj at suse.com>
Reply-To: OpenStack Development Mailing List (not for usage questions)
<openstack-dev at lists.openstack.org>
Organization: SUSE Linux GmbH, GF: Felix Imendörffer, Jane Smithard,
Graham Norton, HRB 21284 (AG Nürnberg)
To: OpenStack Development Mailing List (not for usage questions)
<openstack-dev at lists.openstack.org>

On 04/04/2016 12:12 PM, Thierry Carrez wrote:
> Doug Hellmann wrote:
>>> [...]
>>> We would love to add all sufficiently mature projects to the
>>> installation
>>> guide because it increases visibility and adoption by operators, but we
>>> lack resources to develop a source installation mechanism that
>>> retains as
>>> much simplicity as possible for our audience.
>>
>> I think it would be a big mistake to try to create one guide for
>> installing all OpenStack projects. As you say, testing what we have
>> now is already a monumental task and impedes your ability to make
>> changes.  Adding more projects, with ever more dependencies and
>> configuration issues to the work the same team is doing would bury
>> the current documentation team. So I think focusing on the DefCore
>> list, or even a smaller list of projects with tight installation
>> integration requirements, makes sense for the team currently producing
>> the installation guide.
> 
> Yes, the base install guide should ideally serve as a reference to reach
> that first step where you have all the underlying services (MySQL,
> Rabbit) and a base set of functionality (starterkit:compute ?) installed
> and working. That is where we need high-quality, proactively-checked,
> easy to understand content.
> 
> Then additional guides (ideally produced by each project team with
> tooling and mentoring from the docs team) can pick up from that base
> first step, assuming their users have completed that first step
> successfully.
> 

Fully agreed.

I just wrote a first draft spec for all of this and look forward to reviews.

I'll enhance some more tomorrow, might copy a bit from above (saw this
too late).

https://review.openstack.org/301284

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Felix Imendörffer, Jane Smithard, Graham Norton,
       HRB 21284 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126


__________________________________________________________________________
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






More information about the OpenStack-docs mailing list