openstack
/
heat-dashboard
Code Issues Proposed changes

Improve doc structure 

The current top page of heat-dashboard doc is a bit tricky.
The content of installation is duplicated, for example.

This commit revisit the document structure.

* Drop installation instruction from README
* Drop meaningless indices and tables (which are not working)
* Move DevStack setup to the contributor document
* Merge installation_contents.rst into installation.rst

Change-Id: I897cfe0094358db63a364088fd2b977e234101e8
This commit is contained in:
Akihiro Motoki 2018-02-22 08:12:49 +09:00
parent 678700d029
commit 20ccb58e67
7 changed files with 80 additions and 157 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
README.rst
View File

@ -1,83 +1,15 @@
======================== ==========================
Team and repository tags Welcome to Heat Dashboard!
======================== ==========================
.. image:: https://governance.openstack.org/tc/badges/heat-dashboard.svg Heat dashboard is a horizon plugin for Heat.
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
==============
Heat Dashboard
==============
Horizon plugin for Heat
* License: Apache license * License: Apache license
* Source: http://git.openstack.org/cgit/openstack/heat-dashboard * Source: http://git.openstack.org/cgit/openstack/heat-dashboard
* Bugs: http://bugs.launchpad.net/heat-dashboard * Bugs: http://bugs.launchpad.net/heat-dashboard
Team and repository tags
------------------------
Use Heat Dashboard in DevStack .. image:: https://governance.openstack.org/tc/badges/heat-dashboard.svg
------------------------------ :target: http://governance.openstack.org/reference/tags/index.html
Set up your ``local.conf`` to enable heat-dashboard::
[[local|localrc]]
enable_plugin heat-dashboard https://git.openstack.org/openstack/heat-dashboard
.. note::
You also need to install Heat itself into DevStack to use Heat Dashboard.
Manual Installation
-------------------
Clone both Horizon and Heat Dashboard repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/heat-dashboard
Create a virtual environment and install Horizon relevant packages::
pip install -r horizon/requirements.txt
Create your ``local_settings.py`` file::
cp horizon/openstack_dashboard/local/local_settings.py.example \
horizon/openstack_dashboard/local/local_settings.py
Open newly created ``local_settings.py`` with your text editor,
and set some parameter to connect to your OpenStack environment:
- Set ``OPENSTACK_HOST`` as hostname or IP address of your OpenStack server.
- Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Heat Dashboard with all relevant packages to your Horizon environment::
pip install -e ./heat-dashboard/
Enable heat-dashboard plugin in your Horizon environment::
cp heat-dashboard/heat_dashboard/enabled/* \
horizon/openstack_dashboard/local/enabled
cp heat-dashboard/heat_dashboard/conf/* \
horizon/openstack_dashboard/conf/
cp heat-dashboard/heat_dashboard/local_settings.d/* \
horizon/openstack_dashboard/local/local_settings.d/
Finally you can launch Horizon with Heat Dashboard plugin::
cd horizon
python manage.py runserver 0.0.0.0:8080
Now you can connect to your Horizon including Heat Dashboard plugin
from your browser with URL http://localhost:8080/.

13
doc/source/contributor/devstack.rst Normal file
View File

@ -0,0 +1,13 @@
==============================
Use Heat Dashboard in DevStack
==============================
Set up your ``local.conf`` to enable heat-dashboard::
[[local|localrc]]
enable_plugin heat-dashboard https://git.openstack.org/openstack/heat-dashboard
.. note::
You also need to install Heat itself into DevStack to use Heat Dashboard.

2
doc/source/contributor/index.rst
View File

@ -6,4 +6,4 @@
:maxdepth: 2 :maxdepth: 2
contributing contributing
devstack

23
doc/source/index.rst
View File

@ -3,24 +3,17 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
============================================== .. the main title comes from README.rst
Welcome to the documentation of Heat Dashboard
==============================================
Contents: .. include:: ../../README.rst
Contents
--------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
readme Installation Guide <install/index>
install/index Configuration Guide <configuration/index>
User Documentation <user/index>
contributor/index contributor/index
configuration/index
user/index
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

51
doc/source/install/installation.rst
View File

@ -2,4 +2,53 @@
Installation Installation
============ ============
.. include:: installation_contents.rst Manual Installation
-------------------
Clone both Horizon and Heat Dashboard repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/heat-dashboard
Create a virtual environment and install Horizon relevant packages::
pip install -r horizon/requirements.txt
Create your ``local_settings.py`` file::
cp horizon/openstack_dashboard/local/local_settings.py.example \
horizon/openstack_dashboard/local/local_settings.py
Open newly created ``local_settings.py`` with your text editor,
and set some parameter to connect to your OpenStack environment:
- Set ``OPENSTACK_HOST`` as hostname or IP address of your OpenStack server.
- Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Heat Dashboard with all relevant packages to your Horizon environment::
pip install -e ./heat-dashboard/
Enable heat-dashboard plugin in your Horizon environment::
cp heat-dashboard/heat_dashboard/enabled/* \
horizon/openstack_dashboard/local/enabled
cp heat-dashboard/heat_dashboard/conf/* \
horizon/openstack_dashboard/conf/
cp heat-dashboard/heat_dashboard/local_settings.d/* \
horizon/openstack_dashboard/local/local_settings.d/
Finally you can launch Horizon with Heat Dashboard plugin::
cd horizon
python manage.py runserver 0.0.0.0:8080
Now you can connect to your Horizon including Heat Dashboard plugin
from your browser with URL http://localhost:8080/.

63
doc/source/install/installation_contents.rst
View File

@ -1,63 +0,0 @@
Use Heat Dashboard in DevStack
------------------------------
Set up your ``local.conf`` to enable heat-dashboard::
[[local|localrc]]
enable_plugin heat-dashboard https://git.openstack.org/openstack/heat-dashboard
.. note::
You also need to install Heat itself into DevStack to use Heat Dashboard.
Manual Installation
-------------------
Clone both Horizon and Heat Dashboard repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/openstack/heat-dashboard
Create a virtual environment and install Horizon relevant packages::
pip install -r horizon/requirements.txt
Create your ``local_settings.py`` file::
cp horizon/openstack_dashboard/local/local_settings.py.example \
horizon/openstack_dashboard/local/local_settings.py
Open newly created ``local_settings.py`` with your text editor,
and set some parameter to connect to your OpenStack environment:
- Set ``OPENSTACK_HOST`` as hostname or IP address of your OpenStack server.
- Verify that the ``OPENSTACK_KEYSTONE_URL`` and
``OPENSTACK_KEYSTONE_DEFAULT_ROLE`` settings are correct for your
environment. (They should be correct unless you modified your
OpenStack server to change them.)
Install Heat Dashboard with all relevant packages to your Horizon environment::
pip install -e ./heat-dashboard/
Enable heat-dashboard plugin in your Horizon environment::
cp heat-dashboard/heat_dashboard/enabled/* \
horizon/openstack_dashboard/local/enabled
cp heat-dashboard/heat_dashboard/conf/* \
horizon/openstack_dashboard/conf/
cp heat-dashboard/heat_dashboard/local_settings.d/* \
horizon/openstack_dashboard/local/local_settings.d/
Finally you can launch Horizon with Heat Dashboard plugin::
cd horizon
python manage.py runserver 0.0.0.0:8080
Now you can connect to your Horizon including Heat Dashboard plugin
from your browser with URL http://localhost:8080/.

1
doc/source/readme.rst
View File

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