Skip to content

Commit

Permalink
Merge "Update Trove's README"
Browse files Browse the repository at this point in the history
  • Loading branch information
Zuul authored and openstack-gerrit committed Jun 20, 2018
2 parents 4279fd2 + 71c3caf commit dc88249
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions README.rst
Expand Up @@ -12,24 +12,42 @@ Getting Started

If you'd like to run from the master branch, you can clone the git repo:

git clone https://github.com/openstack/trove
git clone https://git.openstack.org/cgit/openstack/trove

For information on how to contribute to trove, please see
CONTRIBUTING.rst_ and HACKING.rst_

* Wiki: https://wiki.openstack.org/wiki/Trove
* Developer Docs: https://docs.openstack.org/trove/latest/
.. _CONTRIBUTING.rst: https://git.openstack.org/cgit/openstack/trove/plain/CONTRIBUTING.rst
.. _HACKING.rst: https://git.openstack.org/cgit/openstack/trove/plain/HACKING.rst>

You can raise bugs here: https://bugs.launchpad.net/trove
* `Wiki <https://wiki.openstack.org/wiki/Trove>`_
* `Developer Docs <https://docs.openstack.org/trove/latest/>`_

You can raise bugs here:
`Bug Tracker <https://bugs.launchpad.net/trove>`_

The plan for trove can be found at
`Trove Specs <https://specs.openstack.org/openstack/trove-specs/>`_

Python client
-------------
https://git.openstack.org/cgit/openstack/python-troveclient
Python-troveclient_ is a client for Trove.

.. _Python-troveclient: https://git.openstack.org/cgit/openstack/python-troveclient

Dashboard plugin
----------------
Trove-dashboard_ is OpenStack dashbaord plugin for Trove.

.. _Trove-dashboard: https://git.openstack.org/cgit/openstack/trove-dashboard

References
----------

* Installation docs:
https://docs.openstack.org/trove/latest/install/install.html
* Manual installation docs:
https://docs.openstack.org/trove/latest/install/manual_install.html
* Build guest image:
https://docs.openstack.org/trove/latest/admin/building_guest_images.html
* `Installation docs`_
* `Manual installation docs`_
* `Build guest image`_

.. _Installation docs: https://docs.openstack.org/trove/latest/install/install.html
.. _Manual installation docs: https://docs.openstack.org/trove/latest/install/manual_install.html
.. _Build guest image: https://docs.openstack.org/trove/latest/admin/building_guest_images.html

0 comments on commit dc88249

Please sign in to comment.