[OpenStack-docs] Developer and users documentation

Lana Brindley openstack at lanabrindley.com
Thu Apr 14 20:28:58 UTC 2016


On 15/04/16 04:34, Svetlana Karslioglu wrote:
> Hi Lana and all, 
> 
> I have the following questions:
> 
>  1. How users can find the documentation published at docs.openstack.org/developer <http://docs.openstack.org/developer> from the docs.openstack.org <http://docs.openstack.org> page? I couldn't find a way to do it. It looks like unless you know the link to docs.openstacl.org/developer <http://docs.openstacl.org/developer>, you cannot find this documentation. Shouldn't the link to developer's documentation be added to docs.openstack.org <http://docs.openstack.org>?

Jeremy is correct, it's linked under Python Developer Documentation, but I agree that is a little obfuscated. What would you prefer to see here?

>  2. How to access previous versions of documentation published at docs.openstack.org/developer <http://docs.openstack.org/developer>? I tried the following and it did not work:
>       * http://docs.openstack.org/developer/liberty
>       * http://docs.openstack.org/liberty/developer

The documentation on /developer is usually continuously integrated, so there are no versioned docs. Different projects may handle this in different ways that I'm not aware of, though.

>  3. Some of the documentation that we published at docs.openstack.org/developer/fuel-docs <http://docs.openstack.org/developer/fuel-docs> is actually users documentation (Fuel Installation Guide, Fuel User Guide).We would like to publish this documentation separately from the developer documentation and add a link to this documentation at docs.openstack.org <http://docs.openstack.org>? We would like the documentation to continue to live in the fuel-docs repository and we will continue to support it. Please advise on the process here.

At the moment, we don't have the infrastructure to support docs at any URL other than /developer. However, the idea of changing this is been floated as part of larger Newton changes to the Install Guide (see https://review.openstack.org/#/c/301284). I'd love your feedback.

HTH,
Lana

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160415/0092a899/attachment-0001.pgp>


More information about the OpenStack-docs mailing list