[OpenStack-docs] Developer and users documentation

Steve Gordon sgordon at redhat.com
Fri Apr 15 12:58:16 UTC 2016


----- Original Message -----
> From: "Lana Brindley" <openstack at lanabrindley.com>
> To: "Svetlana Karslioglu" <skarslioglu at mirantis.com>
> 
> On 15/04/16 08:29, Svetlana Karslioglu wrote:
> > Hey Jeremy and Lana,
> > 
> > Thanks for the quick reply. I found developer's documentation. I wonder if
> > removing the word "Python" will help. Also, I wonder if moving developer
> > documentation under it's own category will help to increase visibility of
> > this documentation, because the Contributor Guides category does not
> > always reflect the purpose of the guides. Many of the guides that I've
> > seen under the Developer Guides category not only describe how to
> > contribute to the project, but also reveal how to install, configure, use
> > with other components and so on.
> 
> I agree, that's a great idea. I've captured this in a bug:
> https://bugs.launchpad.net/openstack-manuals/+bug/1570642
> 
> > 
> > As for the installation guides discussion, I think it's a very good
> > initiative and I'm happy that it's happening =). I also think this should
> > have a little broader scope and include all user documentation, as, for
> > example, Fuel has not only an Installation guide, but also a User guide
> > that we would like to publish at docs.openstack.org
> > <http://docs.openstack.org> from our own repository. I think that other
> > projects have similar issues as right now many of them just publish both
> > developer and user documentation at docs.openstack.org/developer
> > <http://docs.openstack.org/developer>. And yes, I agree it will help to
> > keep bugs under respective project queues.
> 
> So the current blueprint suggests
> docs.openstack.org/project-install-guide/RELEASE/SERVICE/ but this is still
> very much under discussion. I suggest you add your voice to that
> conversation.
> 
> Lana

I touched on this in the review but I think the missing piece here is identifying where the content for fuel/kolla/tripleo/openstack-ansible/openstack-puppet/openstack-chef would actually be linked in. I don't think it makes sense for these to be grouped in at the end like an additional module to be installed (as opposed to e.g. magnum, manila, trove, etc.), because each of them is actually itself an deployment path for all of OpenStack. It might be a better fit to link the deployment focused big tent projects into the overview in the context of "Trying to perform more advanced installation and configuration? Check out these guides.".

-Steve



More information about the OpenStack-docs mailing list