diff options
| author | Jenkins <jenkins@review.openstack.org> | 2015-01-15 04:05:44 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2015-01-15 04:05:44 +0000 |
| commit | ef8e8bc32c58c834f5c9404939ace2dc94984dcf (patch) | |
| tree | 87b55fb288e592ab9a42a2514b90bc62638e639c | |
| parent | 4a8a2fb27d9f4f4142b019be75e48e872b72b116 (diff) | |
| parent | 558e39aa27e087ee2f939aadc5efcb38533d5369 (diff) | |
| download | python-openstackclient-ef8e8bc32c58c834f5c9404939ace2dc94984dcf.tar.gz | |
Merge "Copy wiki content to index page"
| -rw-r--r-- | doc/source/index.rst | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index 41c24879..7039bab0 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -22,23 +22,38 @@ Contents: Getting Started --------------- -* Check out `the wiki`_ -* Try `some commands`_ +* Try :doc:`some commands <command-list>` * Read the source `on OpenStack's Git server`_ +* Install OpenStackClient from `PyPi`_ or a `tarball`_ -.. _the wiki: https://wiki.openstack.org/OpenStackClient -.. _some commands: https://wiki.openstack.org/OpenStackClient/Commands + +Project Goals +------------- + +* Use the OpenStack Python API libraries, extending or replacing them as required +* Use a consistent naming and structure for commands and arguments +* Provide consistent output formats with optional machine parseable formats +* Use a single-binary approach that also contains an embedded shell that can execute + multiple commands on a single authentication (see libvirt's virsh for an example) +* Independence from the OpenStack project names; only API names are referenced (to + the extent possible) 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`_. +OpenStackClient utilizes all of the usual OpenStack processes and requirements for +contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_ +and `blueprints`_ may be submitted to the :code:`python-openstackclient` project +on `Launchpad`_. Code may be submitted to the +:code:`openstack/python-openstackclient` project using `Gerrit`_. -.. _on OpenStack's Git server: https://git.openstack.org/cgit/openstack/python-openstackclient/tree +.. _`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 +.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs +.. _blueprints: https://blueprints.launchpad.net/python-openstackclient +.. _PyPi: https://pypi.python.org/pypi/python-openstackclient +.. _tarball: http://tarballs.openstack.org/python-openstackclient Indices and Tables ================== |