Reorganize documentation

Bug #1416553 reported by Brian Curtin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack SDK
Fix Released
Undecided
Brian Curtin

Bug Description

The current layout is going to mean a huge amount of stuff goes on the index page of the docs. Too much stuff, in fact.

I think that the docs should be arranged primarily under two headings: for users, and for contributors, in that order

User docs would include the following:
* Change log
* Installation details
* User guides
* API docs - both high level and resource, with high level coming first in any mention
* How to report bugs - where to do it, how to write the report

Contributor docs would include the following:
* How to...build your own auth plugin, create resources for a service, implement a service proxy, modify user preferences, etc
* How to set up a dev environment, run tests, build the docs, run coverage, debugging info, etc.
* Contact information for mailing lists, IRC, etc.

A lot of this is already there or otherwise in progress, but since there's a lot to move it'll take a few changes. This bug is to track those efforts.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-openstacksdk (master)

Fix proposed to branch: master
Review: https://review.openstack.org/151785

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/151886

Revision history for this message
Brian Curtin (brian.curtin) wrote : Re: Reorganize documentation ahead of growth

Here's a doc build of the current changes: http://briancurtin.com/doc_reorg/

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-openstacksdk (master)

Reviewed: https://review.openstack.org/151785
Committed: https://git.openstack.org/cgit/stackforge/python-openstacksdk/commit/?id=f86cc2fc8ebd12ed98a72f93b29506a0a8d433f6
Submitter: Jenkins
Branch: master

commit f86cc2fc8ebd12ed98a72f93b29506a0a8d433f6
Author: Brian Curtin <email address hidden>
Date: Fri Jan 30 15:36:14 2015 -0600

    Reorganize existing documentation files

    This change creates two directories of content, based on who they're
    relevant to: users and contributors. Files which were in the top-level
    folder were moved, as well as some within folders in that top-level.
    This is one change of a multi-step process, so it only deals with
    renamings in order to make further changes cleaner.

    Change-Id: I3c9bb7da4f283e2696e7bcea84824c778bbcecfb
    Partial-Bug: 1416553

Revision history for this message
Brian Curtin (brian.curtin) wrote : Re: Reorganize documentation ahead of growth

Need to add a section on logging to the user docs.

summary: - Reorganize documentation ahead of growth
+ Reorganize documentation
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-openstacksdk (master)

Reviewed: https://review.openstack.org/151886
Committed: https://git.openstack.org/cgit/stackforge/python-openstacksdk/commit/?id=9b2729cdd5843edce87d1193cc30827c3967ae64
Submitter: Jenkins
Branch: master

commit 9b2729cdd5843edce87d1193cc30827c3967ae64
Author: Brian Curtin <email address hidden>
Date: Sat Jan 31 10:31:35 2015 -0600

    Build up user documentation section

    This change creates a section of the documentation focused on users,
    holding the guides, API docs, etc. Another change will focus on
    documentation for contributors.

    * Installation details were moved straight into the user index.
      Installation details for contributors will go into that section.
    * The old usage.rst section was moved into the userguides/ section and
      will grow into a Connection guide in another change.
    * The sections were organized according top to bottom in order of
      likelihood of utility to users. The guides will help people get
      started, the API docs will help them go from there, and anyone needing
      to customize lower-level things will have already scrolled through the
      preceeding sections to get to the end.
    * In order to see how the Resource docs turn out to be organized, I
      added pages for Compute and Database resources. We'll need to add them
      for every service, but I didn't want to overload this change with all
      of those additions.
    * Since glossary isn't linked in a TOC anywhere, just mentioned
      explicitly at the beginning of the user section, I added an exclude
      for it in the conf.py. It still gets built, but that allows it to not
      become a warning for being left out of TOCs.

    Change-Id: If9d1e4726ed14d5b7592c9da00c27591d2a4291c
    Partial-Bug: 1416553

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/151902
Committed: https://git.openstack.org/cgit/stackforge/python-openstacksdk/commit/?id=e2f198d6883a04e5fe9d30de13e665088ebe3c11
Submitter: Jenkins
Branch: master

commit e2f198d6883a04e5fe9d30de13e665088ebe3c11
Author: Brian Curtin <email address hidden>
Date: Sat Jan 31 18:32:49 2015 -0600

    Build up contributor documentation section

    This change shifts a few things from the old contributing.rst file and
    begins to expand in a few areas. A lot of the contents are broken out
    into separate files, and there's a start on guidelines of how to
    contribute new features for services.

    Change-Id: I9e04c4ee6bdb25026defb3cccebaef4df61bb3d3
    Partial-Bug: 1416553

Changed in python-openstacksdk:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.