Jump to: navigation, search

Difference between revisions of "Glance-where-are-the-docs"

m ("dev docs" written for Python developers by developers working on glance)
m
Line 7: Line 7:
 
</div>
 
</div>
  
== "dev docs" written for Python developers by developers working on glance ==
+
== "dev docs" written for OpenStack contributors by the OpenStack developers working on Glance ==
 +
* audience: software developers who want to work on Glance and/or the python-glanceclient
 
* generated from the rst files in the doc/source directory in the source code
 
* generated from the rst files in the doc/source directory in the source code
 +
** https://github.com/openstack/glance
 
* posted at:
 
* posted at:
** http://docs.openstack.org/developer/glance/
+
** http://docs.openstack.org/developer/glance/
 
** http://docs.openstack.org/developer/python-glanceclient/
 
** http://docs.openstack.org/developer/python-glanceclient/
 +
** status: not versioned, should always reflect master
 
* content: should contain information for contributors to the Glance project itself
 
* content: should contain information for contributors to the Glance project itself
 
* file bugs at:
 
* file bugs at:
Line 18: Line 21:
 
* generate the docs locally withː
 
* generate the docs locally withː
 
** tox -e docs
 
** tox -e docs
** It will create a directory /opt/stack/glance/doc/build which has html and man subdir’s
+
** It will create a directory /opt/stack/glance/doc/build which has html and man subdirectories
  
 
== "API docs" written for application developers and people who upload images programmatically ==
 
== "API docs" written for application developers and people who upload images programmatically ==

Revision as of 12:40, 30 July 2015

This info is accurate as of 5 September 2014.

Info about contributing to the documentation is here: https://wiki.openstack.org/wiki/Documentation (basically, you clone a repo and use gerrit just like you do for code)

Note to Glance devs: file a bug when you plan to contribute to/update documentation so there's no duplication of effort.

"dev docs" written for OpenStack contributors by the OpenStack developers working on Glance

"API docs" written for application developers and people who upload images programmatically

API Quick Reference Docs

"operator docs"

End User Guide