[OpenStack-docs] Installation guide disintegration

Andreas Jaeger aj at suse.com
Thu Jul 21 05:46:33 UTC 2016


On 07/20/2016 07:24 PM, Matt Kassawara wrote:
> I'm trying to avoid working on the installation guide outside of fixing
> bugs, but came across a patch [1] that requires a bit more effort for
> proper integration. In the patch, the Block Storage backup service
> depends on the Object Storage service. The content for the latter
> recently moved to the swift repository. While trying to fix references
> to the Object Storage service, I found the following problems:
> 
> 1) The URLs to project-specific guides [2] return 404s, making the
> content difficult to test.
> 2) The primary guide still references the swift storage nodes [3,4], but
> the content describing how to configure the hosts (particularly the
> network configuration) no longer exists anywhere [5]. Thus, swift is not
> installable.
> 3) Looking at the source of some project-specific guides, the content
> varies enough to reduce or eliminate the consistency of the original
> guide, a rather important attribute for our audience. In particular,
> most projects seem to lack support for all distributions. Someone
> wanting to evaluate Zaqar may install core services on Ubuntu and only
> later realize the instructions for Zaqar only support RDO packages [6].

That has two sides: We now have Zaqar documents! Yeah! Something that
was not possible before.

If there is interest, support for other distributions will be added for
sure.

When doing this move, we deliberately gave up control for the Install
Guides and gave guidelines instead. We do not enforce that a project
supports all distros.

And that's part of the suggestion you made a few days ago - moving
documents to repos. It means giving up control. This is changing how we
work and operate, and we all need to adopt to it.

We have to decide whether we enable, provide guidelines, review, control
- and to which level.

So, I see this all as part of the pain of changing and instead of
disintegration, see good steps forward and like to thank all involved,

Andreas

> 
> [1] https://review.openstack.org/#/c/293331/
> [2] http://docs.openstack.org/draft/install-guide-ubuntu/additional-services.html
> [3] http://docs.openstack.org/mitaka/install-guide-ubuntu/overview.html
> [4] http://docs.openstack.org/mitaka/install-guide-ubuntu/environment-networking.html
> [5] http://docs.openstack.org/mitaka/install-guide-ubuntu/environment-networking-storage-swift.html
> [6] https://github.com/openstack/zaqar/tree/master/install-guide/source
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 


-- 
 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




More information about the OpenStack-docs mailing list