Skip to content

Commit ef8e8bc

Browse files
Jenkinsopenstack-gerrit
authored andcommitted
Merge "Copy wiki content to index page"
2 parents 4a8a2fb + 558e39a commit ef8e8bc

1 file changed

Lines changed: 23 additions & 8 deletions

File tree

‎doc/source/index.rst‎

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,38 @@ Contents:
2222
Getting Started
2323
---------------
2424

25-
* Check out `the wiki`_
26-
* Try `some commands`_
25+
* Try :doc:`some commands <command-list>`
2726
* Read the source `on OpenStack's Git server`_
27+
* Install OpenStackClient from `PyPi`_ or a `tarball`_
2828

29-
.. _the wiki: https://wiki.openstack.org/OpenStackClient
30-
.. _some commands: https://wiki.openstack.org/OpenStackClient/Commands
29+
30+
Project Goals
31+
-------------
32+
33+
* Use the OpenStack Python API libraries, extending or replacing them as required
34+
* Use a consistent naming and structure for commands and arguments
35+
* Provide consistent output formats with optional machine parseable formats
36+
* Use a single-binary approach that also contains an embedded shell that can execute
37+
multiple commands on a single authentication (see libvirt's virsh for an example)
38+
* Independence from the OpenStack project names; only API names are referenced (to
39+
the extent possible)
3140

3241
Contributing
3342
============
3443

35-
Code is hosted `on OpenStack's Git server`_. Submit bugs to the
36-
python-openstackclient project on `Launchpad`_. Submit code to
37-
the openstack/python-openstackclient project using `Gerrit`_.
44+
OpenStackClient utilizes all of the usual OpenStack processes and requirements for
45+
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
46+
and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
47+
on `Launchpad`_. Code may be submitted to the
48+
:code:`openstack/python-openstackclient` project using `Gerrit`_.
3849

39-
.. _on OpenStack's Git server: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
50+
.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
4051
.. _Launchpad: https://launchpad.net/python-openstackclient
4152
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
53+
.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
54+
.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
55+
.. _PyPi: https://pypi.python.org/pypi/python-openstackclient
56+
.. _tarball: http://tarballs.openstack.org/python-openstackclient
4257

4358
Indices and Tables
4459
==================

0 commit comments

Comments
 (0)