summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorzhanggang <zhanggang@cmss.chinamobile.com>2018-06-11 11:23:28 +0800
committerzhanggang <zhanggang@cmss.chinamobile.com>2018-06-13 19:05:33 +0800
commit71c3caf407a9e2dd239616ee1709bdd8ad0221a4 (patch)
tree31c326067d6b3c8cf996537881dcfc068b5b6ff6 /README.rst
parent9cdb08cb7be0a2b9edf2b3ce173009606750ea97 (diff)
downloadtrove-71c3caf407a9e2dd239616ee1709bdd8ad0221a4.tar.gz
Update Trove's README
Update the README.rst, change the repo url from github to git.openstack.org, add link for trove-sepcs and trove-dashboard, add link for CONTRIBUTING.rst and HACKING.rst. Signed-off-by: zhanggang <zhanggang@cmss.chinamobile.com> Change-Id: If1c7d3467c7da261ac626325a44aa7eab37ae042
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst40
1 files changed, 29 insertions, 11 deletions
diff --git a/README.rst b/README.rst
index 2a9a2c15..eb3080c6 100644
--- a/README.rst
+++ b/README.rst
@@ -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