[OpenStack-docs] Some ideas for enhanced Install Guide

Kato, Tomoyuki kato.tomoyuki at jp.fujitsu.com
Mon May 9 00:08:58 UTC 2016


> We had some discussions in Austin on how to go forward with the Install
> Guides and I've wrote up a couple of steps.
> 
> Note that this is not complete but something for us to discuss. Lana,
> please add what we agree on in your spec.
> 
> 
> 1) Cookiecutter for project specific install guides with basic
>   structure. Make this part of docs team repos...
> 
>   First draft at:
>   https://github.com/ajaeger/cookiecutter-installguide
> 
>   A cookiecutter allows a project to easily setup the structure for the
> guide. Please review what I've done and see whether that works.

Nice work!
Do we use "only" directive for each distro?
I don't want to use it to avoid complex things for Advanced Install Guide.
Alternatively, I'd like to add the conditional description. For example,

  1. install the packages:
      For Ubuntu,
              xxxx
      For xxxx,
              xxxx ....

KATO Tomoyuki

>   Advanced Install Guides
> 
>   These are additional services that you can install independent of
>   each other on top of your basic OpenStack cloud. The instructions
>   assume the setup described in the chapters of the "Basic Install
>   Guides":
> 
>   * Install Guide for Database Service (Trove)
>   * Install Guide for Container Service (Magnum)
>   * ...



More information about the OpenStack-docs mailing list