python-openstackclient/doc/source/index.rst

===============
OpenStackClient
===============

OpenStackClient (aka OSC) is a command-line client for OpenStack that
brings the command set for Compute, Identity, Image, Object Store and Volume
APIs together in a single shell with a uniform command structure.

Contents:

.. toctree::
   :maxdepth: 1

   releases
   command-list
   commands
   plugins
   authentication
   interactive
   man/openstack

Getting Started
---------------

* Check out `the wiki`_
* Try `some commands`_
* Read the source `on OpenStack's Git server`_

.. _the wiki: https://wiki.openstack.org/OpenStackClient
.. _some commands: https://wiki.openstack.org/OpenStackClient/Commands

Contributing
============

Code is hosted `on OpenStack's Git server`_. Submit bugs to the
python-openstackclient project on `Launchpad`_. Submit code to
the openstack/python-openstackclient project using `Gerrit`_.

.. _on OpenStack's Git server: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
.. _Launchpad: https://launchpad.net/python-openstackclient
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow

Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Update docs and release notes for 0.4.0 Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c 2014-05-15 09:05:37 -05:00			`===============`
			`OpenStackClient`
			`===============`
First commit 2012-04-18 13:16:39 -05:00
Update docs and release notes for 0.4.0 Change-Id: Iad6cfe5dee63adb9e60a0ea9811217b3175eb99c 2014-05-15 09:05:37 -05:00			`OpenStackClient (aka OSC) is a command-line client for OpenStack that`
Update docs and release notes for 0.4.1 release Closes-Bug: 1365505 Change-Id: I027d263ba9980715454b034a37733c5ff23fd169 2014-09-06 14:32:47 -05:00			`brings the command set for Compute, Identity, Image, Object Store and Volume`
			`APIs together in a single shell with a uniform command structure.`
First commit 2012-04-18 13:16:39 -05:00
			`Contents:`

			`.. toctree::`
			`:maxdepth: 1`

Add release notes in docs Change-Id: I49dc936a37848745ce3412e810b98348558d1157 2013-08-06 12:43:22 -05:00			`releases`
Begin copying wiki command list here * Sort by command objects * Drop the comparison to the project CLIs * Minor updates to command help to match docs Initially include the cross-API commands to establish the structure and format. Change-Id: I77a7b3c89e088b66aa62941e29ce0b65b532285b 2014-11-17 16:42:30 -06:00			`command-list`
Prep for 0.2 release (0.2.rc1) * rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file * add the barest of pointers to the wiki, etc. to the source docs * add a bare-bones man page Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe 2013-07-29 17:05:02 -05:00			`commands`
Update docs for plugins and release notes * Fill out the existing command and man page * Add a plugins page. * Begin the release notes for 0.3.0 Change-Id: I4527fed28a10a9d79fc8f6c1d925a4bf0d0a7a36 2013-12-05 13:23:44 -06:00			`plugins`
Add authentication description doc This is represents the current operation Closes-Bug: #1337422 Change-Id: I8092e7723b563647e13b6e2f0b7901a16572b6c7 2014-10-24 10:34:41 -05:00			`authentication`
Add documentation of interactive mode This is a light description with some examples. Change-Id: Iff9ad904a150f2bb7673bd4106cf26bcefec08b9 2014-12-02 16:57:22 -06:00			`interactive`
Prep for 0.2 release (0.2.rc1) * rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file * add the barest of pointers to the wiki, etc. to the source docs * add a bare-bones man page Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe 2013-07-29 17:05:02 -05:00			`man/openstack`

First commit 2012-04-18 13:16:39 -05:00			`Getting Started`
			`---------------`

Prep for 0.2 release (0.2.rc1) * rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file * add the barest of pointers to the wiki, etc. to the source docs * add a bare-bones man page Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe 2013-07-29 17:05:02 -05:00			* Check out `the wiki`_
			* Try `some commands`_
Acknowlege git.o.o as OpenStack's git server OpenStack's cannonical git server is at git.o.o this patch updates the index.rst to reflect that. Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41 2014-09-18 17:05:07 -04:00			* Read the source `on OpenStack's Git server`_
Prep for 0.2 release (0.2.rc1) * rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file * add the barest of pointers to the wiki, etc. to the source docs * add a bare-bones man page Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe 2013-07-29 17:05:02 -05:00
			`.. _the wiki: https://wiki.openstack.org/OpenStackClient`
			`.. _some commands: https://wiki.openstack.org/OpenStackClient/Commands`
First commit 2012-04-18 13:16:39 -05:00
			`Contributing`
			`============`

Acknowlege git.o.o as OpenStack's git server OpenStack's cannonical git server is at git.o.o this patch updates the index.rst to reflect that. Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41 2014-09-18 17:05:07 -04:00			Code is hosted `on OpenStack's Git server`_. Submit bugs to the
			python-openstackclient project on `Launchpad`_. Submit code to
			the openstack/python-openstackclient project using `Gerrit`_.
First commit 2012-04-18 13:16:39 -05:00
Acknowlege git.o.o as OpenStack's git server OpenStack's cannonical git server is at git.o.o this patch updates the index.rst to reflect that. Change-Id: I54eeea7fab2e0f64ca9f23f7c328e2ff19721a41 2014-09-18 17:05:07 -04:00			`.. _on OpenStack's Git server: https://git.openstack.org/cgit/openstack/python-openstackclient/tree`
Update Contributing blurb in the docs. Contributing blurb previously mentioned social coding and Github. The OpenStack contribution workflow is slightly different. Provide details on Github, LP, and Gerrit. Change-Id: Ie5ecd25e5828de611561f37b3acbccc5cf3f0d04 2012-06-22 10:24:44 -07:00			`.. _Launchpad: https://launchpad.net/python-openstackclient`
Workflow documentation is now in infra-manual Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: Id09c9bdf8804c1ed90e49606e76ffbff1d96a7c2 2014-12-05 03:30:40 +00:00			`.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow`
First commit 2012-04-18 13:16:39 -05:00
Enhance the theming for modules page Also fixes a few small docstring syntax errors Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074 2014-11-18 00:16:21 -05:00			`Indices and Tables`
			`==================`
First commit 2012-04-18 13:16:39 -05:00
			* :ref:`genindex`
			* :ref:`modindex`
			* :ref:`search`