[OpenStack-docs] Developer and users documentation

Svetlana Karslioglu skarslioglu at mirantis.com
Thu Apr 14 22:29:02 UTC 2016


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.

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 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. And yes, I agree it will help to keep bugs
under respective project queues.

Thanks,
Svetlana

On Thu, Apr 14, 2016 at 1:28 PM, Lana Brindley <openstack at lanabrindley.com>
wrote:

> 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
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
>


-- 
Thanks,

Svetlana Karslioglu
Sr. Technical Writer
Mirantis, Inc.
408-476-1692
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160414/6c810536/attachment.html>


More information about the OpenStack-docs mailing list