Rearrange existing documentation to fit the new standard layout
This patch changes directory structure for docs. For more detail, see the doc migration spec: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: I9c0ea03780b4fe0348408b1ca1d1532acb55977e
This commit is contained in:
Shu Muto
parent
49a8d768bc
commit
4ba585edd2
65
README.rst
65
README.rst
|
|
@ -13,68 +13,11 @@ Senlin Dashboard
|
|||
|
||||
Senlin Management Dashboard
|
||||
|
||||
Installation
|
||||
------------
|
||||
.. include:: doc/source/contributor/hosts.rst
|
||||
|
||||
1. Clone the Senlin Dashboard repository::
|
||||
.. include:: doc/source/install/index.rst
|
||||
|
||||
$ git clone https://git.openstack.org/openstack/senlin-dashboard
|
||||
.. include:: doc/source/contributor/develop.rst
|
||||
|
||||
2. Copy the ``_50_senlin.py`` file from ``senlin_dashboard/enabled/_50_senlin.py``
|
||||
file to ``horizon/openstack_dashboard/local/enabled`` directory. Example,
|
||||
set as if being executed from the root of the senlin-dashboard repository::
|
||||
.. include:: doc/source/configuration/index.rst
|
||||
|
||||
cp ./senlin_dashboard/enabled/_50_senlin.py ../horizon/openstack_dashboard/local/enabled
|
||||
|
||||
3. Change into the senlin-dashboard repository and package the plugin::
|
||||
|
||||
pip install -r requirements.txt -e .
|
||||
|
||||
This will build and install the senlin-dashboard plugin into the active virtual
|
||||
environment associated with your horizon installation. The plugin is installed
|
||||
in "editable" mode as a link back to your senlin-dashboard plugin directory.
|
||||
|
||||
Devstack Installation
|
||||
---------------------
|
||||
|
||||
|
||||
1. Download DevStack::
|
||||
|
||||
$ git clone https://git.openstack.org/openstack-dev/devstack
|
||||
$ cd devstack
|
||||
|
||||
2. Add following repo as external repositories into your ``local.conf`` file::
|
||||
|
||||
[[local|localrc]]
|
||||
#Enable senlin
|
||||
enable_plugin senlin https://git.openstack.org/openstack/senlin
|
||||
|
||||
3. Run ``stack.sh``::
|
||||
|
||||
$ ./stack.sh
|
||||
|
||||
Unit Test
|
||||
---------
|
||||
|
||||
The unit tests can be executed directly from within this Senlin Dashboard plugin
|
||||
project directory by using::
|
||||
|
||||
tox
|
||||
|
||||
Switch to Angularized panels
|
||||
----------------------------
|
||||
|
||||
The panels are ongoing to migrate to AngularJS based. If you would try them,
|
||||
please copy ``_59_toggle_angular_senlin_dashboard.py.example`` to
|
||||
``horizon/openstack_dashboard/local_settings.d/_59_toggle_angular_senlin_dashboard.py``
|
||||
and restart Horizon.
|
||||
|
||||
Blueprints
|
||||
----------
|
||||
|
||||
- Blueprints: https://blueprints.launchpad.net/senlin-dashboard
|
||||
|
||||
Bug Tracking
|
||||
------------
|
||||
|
||||
- Bugs: https://bugs.launchpad.net/senlin-dashboard
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Switch to Angularized panels
|
||||
----------------------------
|
||||
|
||||
The panels are ongoing to migrate to AngularJS based. If you would try them,
|
||||
please copy ``_59_toggle_angular_senlin_dashboard.py.example`` to
|
||||
``horizon/openstack_dashboard/local_settings.d/_59_toggle_angular_senlin_dashboard.py``
|
||||
and restart Horizon.
|
||||
|
||||
For more information on configuration, see
|
||||
`Configuration Guide
|
||||
<https://docs.openstack.org/horizon/latest/configuration/index.html>`__
|
||||
in the Horizon documentation.
|
||||
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
Devstack Installation
|
||||
---------------------
|
||||
|
||||
1. Download DevStack::
|
||||
|
||||
$ git clone https://git.openstack.org/openstack-dev/devstack
|
||||
$ cd devstack
|
||||
|
||||
2. Add following repo as external repositories into your ``local.conf`` file::
|
||||
|
||||
[[local|localrc]]
|
||||
#Enable senlin
|
||||
enable_plugin senlin https://git.openstack.org/openstack/senlin
|
||||
|
||||
3. Run ``stack.sh``::
|
||||
|
||||
$ ./stack.sh
|
||||
|
||||
Unit Test
|
||||
---------
|
||||
|
||||
The unit tests can be executed directly from within this Senlin Dashboard plugin
|
||||
project directory by using::
|
||||
|
||||
tox
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
Project Hosting
|
||||
---------------
|
||||
|
||||
- Blueprints: https://blueprints.launchpad.net/senlin-dashboard
|
||||
- Bugs: https://bugs.launchpad.net/senlin-dashboard
|
||||
|
||||
Mailing list
|
||||
------------
|
||||
|
||||
Use ``[senlin-dashboard]`` prefix in subjects with 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
|
||||
|
|
@ -1,5 +1,3 @@
|
|||
.. _contributing:
|
||||
|
||||
================================
|
||||
Contributing to Senlin Dashboard
|
||||
================================
|
||||
|
|
@ -32,19 +30,7 @@ authentication.
|
|||
* 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
|
||||
.. include:: hosts.rst
|
||||
|
||||
.. include:: develop.rst
|
||||
|
||||
|
|
@ -2,17 +2,21 @@
|
|||
Welcome to Senlin Dashboard's documentation!
|
||||
============================================
|
||||
|
||||
Contents:
|
||||
User Documentation
|
||||
------------------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:maxdepth: 2
|
||||
|
||||
readme
|
||||
contributing
|
||||
install/index
|
||||
configuration/index
|
||||
Release Notes <https://docs.openstack.org/releasenotes/senlin-dashboard>
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
Contributor Guide
|
||||
-----------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
contributor/index
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
|
||||
Before install the Senlin Dashboard, setup the Horizon.
|
||||
To setup the Horizon, see
|
||||
`Installation Guide
|
||||
<https://docs.openstack.org/horizon/latest/install/index.html>`__
|
||||
in the Horizon documentation.
|
||||
|
||||
1. Clone the Senlin Dashboard repository::
|
||||
|
||||
$ git clone https://git.openstack.org/openstack/senlin-dashboard
|
||||
|
||||
2. Copy the ``_50_senlin.py`` file from ``senlin_dashboard/enabled/_50_senlin.py``
|
||||
file to ``horizon/openstack_dashboard/local/enabled`` directory. Example,
|
||||
set as if being executed from the root of the senlin-dashboard repository::
|
||||
|
||||
cp ./senlin_dashboard/enabled/_50_senlin.py ../horizon/openstack_dashboard/local/enabled
|
||||
|
||||
3. Change into the senlin-dashboard repository and package the plugin::
|
||||
|
||||
pip install -r requirements.txt -e .
|
||||
|
||||
This will build and install the senlin-dashboard plugin into the active virtual
|
||||
environment associated with your horizon installation. The plugin is installed
|
||||
in "editable" mode as a link back to your senlin-dashboard plugin directory.
|
||||
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../README.rst
|
||||
Loading…
Reference in New Issue