deb-sahara-dashboard/README.rst
Flavio Percoco 3d7ed540c5 Show team and repo badges on README
This patch adds the team's and repository's badges to the README file.
The motivation behind this is to communicate the project status and
features at first glance.

For more information about this effort, please read this email thread:

http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html

To see an example of how this would look like check:

https://gist.github.com/d4c8e744698ee0ef79d02b5390f7d707

Change-Id: Ibd183d1e5cb2734c3b9b1d17b198d875c9664fa4
2016-11-25 15:27:40 +01:00

62 lines
1.6 KiB
ReStructuredText

========================
Team and repository tags
========================
.. image:: http://governance.openstack.org/badges/sahara-dashboard.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
OpenStack Dashboard plugin for Sahara project
=============================================
How to use with Horizon on server:
----------------------------------
Use pip to install the package on the server running Horizon. Then either copy
or link the files in sahara_dashboard/enabled to
openstack_dashboard/local/enabled. This step will cause the Horizon service to
pick up the Sahara plugin when it starts.
How to use with devstack:
-------------------------
Add the following to your devstack ``local.conf`` file::
enable_plugin sahara-dashboard git://git.openstack.org/openstack/sahara-dashboard
To run unit tests:
------------------
./run_tests.sh
NOTE:
=====
As of the Mitaka release, the dashboard for sahara is now maintained
outside of the horzon codebase, in the repository.
Links:
------
Sahara project: https://github.com/openstack/sahara
Sahara at wiki.openstack.org: https://wiki.openstack.org/wiki/Sahara
Launchpad project: https://launchpad.net/sahara
Sahara docs site: http://docs.openstack.org/developer/sahara
Roadmap: https://wiki.openstack.org/wiki/Sahara/Roadmap
Quickstart guide: http://docs.openstack.org/developer/sahara/devref/quickstart.html
How to participate: http://docs.openstack.org/developer/sahara/devref/how_to_participate.html
License
-------
Apache License Version 2.0 http://www.apache.org/licenses/LICENSE-2.0