openstack/trove
Code Issues Proposed changes

Update Trove's README

Browse Source 
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
This commit is contained in:
zhanggang 2018-06-11 11:23:28 +08:00
parent 9cdb08cb7b
commit 71c3caf407
1 changed files with 29 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.rst
View File

@ -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