Reorganize docs

Currently our docs is only the README, this reorganized it and will
add more docs later then add a job to publish it to docs.openstack.org

Depends-On: I30eb86aa42ef3b2dc2a40749ce2b36a25b55fe2c
Change-Id: I054ddfc1f61fa0d5df63ef27c29fe82d8bedc25b
This commit is contained in:
Zhenguo Niu 2017-02-13 14:19:25 +08:00 committed by Qiming Teng
parent d5746fe074
commit 4acf7dc5b2
3 changed files with 69 additions and 1 deletions

View File

@ -0,0 +1,50 @@
.. _contributing:
================================
Contributing to Senlin Dashboard
================================
If you're interested in contributing to the Senlin Dashboard project,
the following will help get you started.
Contributor License Agreement
-----------------------------
.. index::
single: license; agreement
In order to contribute to the Senlin Dashboard project, you need to have
signed OpenStack's contributor's agreement.
.. seealso::
* http://docs.openstack.org/infra/manual/developers.html
* http://wiki.openstack.org/CLA
LaunchPad Project
-----------------
Most of the tools used for OpenStack depend on a launchpad.net ID for
authentication.
.. seealso::
* https://launchpad.net
* https://launchpad.net/senlin-dashboard
Project Hosting Details
-------------------------
Bug tracker
http://launchpad.net/senlin-dashboard
Mailing list (prefix subjects with ``[senlin-dashboard]`` for faster responses)
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
Code Hosting
https://git.openstack.org/cgit/openstack/senlin-dashboard
Code Review
https://review.openstack.org/#/q/status:open+project:openstack/senlin-dashboard,n,z

View File

@ -1 +1,18 @@
.. include:: ../../README.rst
Welcome to Senlin Dashboard's documentation!
============================================
Contents:
.. toctree::
:maxdepth: 1
readme
contributing
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

1
doc/source/readme.rst Normal file
View File

@ -0,0 +1 @@
.. include:: ../../README.rst