[OpenStack-docs] [install-guide] Mimicking the install-guide for project specific install guides

Ravi, Goutham Goutham.Ravi at netapp.com
Thu Jun 23 22:42:53 UTC 2016

Thank you Lana! I updated the build job (https://review.openstack.org/317152) to follow the following doc structure:

├── build
│   ├── doctrees
│   │   ├── debian.doctrees
│   │   ├── obs.doctrees
│   │   ├── rdo.doctrees
│   │   └── ubuntu.doctrees
│   └── html
│       ├── debian
│       ├── obs
│       ├── rdo
│       └── ubuntu
├── source
│   └── figures
└── tools

One easy way could be to stick a top level index on the html output:

So, the URL can still be: http://docs.openstack.org/project-install-guide/{project-name}/{releasename-or-draft}/index.html which could link to the specific distros.. 


On 6/23/16, 5:18 PM, "Lana Brindley" <openstack at lanabrindley.com> wrote:

Hi Goutham,

Adding in Andreas and the docs mailing list :)

I can't see a problem with having the guides be distro-specific, if that works for individual projects. We just need to work out how to present it on the index page.


On 23/06/16 23:01, Ravi, Goutham wrote:
> Hi Lana / Install guide docs team
> I haven’t been to the install-guide meetings, but looking at the logs and your mails on the ML, I learned that a lot of work’s gone into creating the cookie-cutter <https://github.com/openstack/installguide-cookiecutter> and project specific install guides in Heat <https://github.com/openstack/heat/tree/master/install-guide/source>, Ceilometer <https://review.openstack.org/#/c/330051/>, Magnum <https://blueprints.launchpad.net/magnum/+spec/magnum-installation-guide>. In the manila project, I wanted to see the feasibility of building the install guide in the same way as it is built today, distro-specific. I spoke to Andreas over IRC today and he suggested I get your opinion on the matter. You may be aware that heat and magnum have decided to build separate indices and split out the information for each distro. Spyrios suggested that cookie-cutter be amended to have these distros: https://review.openstack.org/#/c/332161/
> While I think it’s a decent approach, why not mimic what we have today with the ‘only’ tags? So, I ported the code to parse the “only” tags from the openstack-manuals project. I was wondering if you can take a look at it and help me navigate through the build here: https://review.openstack.org/#/c/317152/. I can propose a change to the cookie cutter if you think this is a sane approach.
> Thanks,
> Goutham

Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia

More information about the OpenStack-docs mailing list