openstack/openstack-manuals
Code Issues Proposed changes

[install-guide] Use toctree instead of include

Browse Source 
Break up dashboard chapter into each dashboard sections.

Change-Id: I4f0b698e8416e08309a00a8b616d21d2152ebab5
Implements: blueprint installguide-liberty
This commit is contained in:
KATO Tomoyuki 2015-07-18 10:37:01 +09:00
parent 371c5e6911
commit 32c5c54256
4 changed files with 49 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/install-guide-rst/source/dashboard-install.rst
View File

@ -1,5 +1,6 @@
=====================
Install and configure
~~~~~~~~~~~~~~~~~~~~~
=====================
This section describes how to install and configure the dashboard
on the controller node.
@ -19,7 +20,7 @@ Memcached as described in keystone-install.
.. TODO: add link to keystone-install after creation.
To install the dashboard components
-----------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: obs
@ -51,7 +52,7 @@ To install the dashboard components
remove this package to restore the original OpenStack theme.
To configure the dashboard
--------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: obs
@ -122,7 +123,7 @@ To configure the dashboard
<http://en.wikipedia.org/wiki/List_of_tz_database_time_zones>`__.
To finalize installation
------------------------
~~~~~~~~~~~~~~~~~~~~~~~~
.. only:: rdo

41
doc/install-guide-rst/source/dashboard-next-step.rst Normal file
View File

@ -0,0 +1,41 @@
==========
Next steps
==========
Your OpenStack environment now includes the dashboard. You can
launch an instance or add
more services to your environment in the following chapters.
After you install and configure the dashboard, you can
complete the following tasks:
.. TODO: add link to "launch an instance" after creation.
* Provide users with a public IP address, a username, and a password
so they can access the dashboard through a web browser. In case of
any SSL certificate connection problems, point the server
IP address to a domain name, and give users access.
* Customize your dashboard. See section
`Customize the dashboad <http://docs.openstack.org/admin-guide-cloud/
content/ch_install-dashboard.html#dashboard-custom-brand>`__
in the `OpenStack Cloud Administrator Guide
<http://docs.openstack.org/admin-guide-cloud/content/>`__
for information on setting up colors, logos, and site titles.
* Set up session storage. See section
`Set up session storage for the dashboard
<http://docs.openstack.org/admin-guide-cloud/content/
dashboard-sessions.html#dashboard-sessions>`__
in the `OpenStack Cloud Administrator Guide
<http://docs.openstack.org/admin-guide-cloud/content>`__
for information on user session data.
* To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets.
For details about browsers that support noVNC, see
`README
<https://github.com/kanaka/noVNC/blob/master/README.md>`__
and `browser support
<https://github.com/kanaka/noVNC/wiki/Browser-support>`__.

3
doc/install-guide-rst/source/dashboard-verify.rst
View File

@ -1,5 +1,6 @@
================
Verify operation
~~~~~~~~~~~~~~~~
================
This section describes how to verify operation of the dashboard.

45
doc/install-guide-rst/source/horizon.rst
View File

@ -16,51 +16,8 @@ Horizon provides a set of core classes and reusable templates and tools.
This example deployment uses an Apache web server.
.. include:: dashboard-install.rst
.. include:: dashboard-verify.rst
.. toctree::
:hidden:
dashboard-install.rst
dashboard-verify.rst
Next steps
~~~~~~~~~~
Your OpenStack environment now includes the dashboard. You can
launch an instance or add
more services to your environment in the following chapters.
After you install and configure the dashboard, you can
complete the following tasks:
.. TODO: add link to "launch an instance" after creation.
* Provide users with a public IP address, a username, and a password
so they can access the dashboard through a web browser. In case of
any SSL certificate connection problems, point the server
IP address to a domain name, and give users access.
* Customize your dashboard. See section
`Customize the dashboad <http://docs.openstack.org/admin-guide-cloud/
content/ch_install-dashboard.html#dashboard-custom-brand>`__
in the `OpenStack Cloud Administrator Guide
<http://docs.openstack.org/admin-guide-cloud/content/>`__
for information on setting up colors, logos, and site titles.
* Set up session storage. See section
`Set up session storage for the dashboard
<http://docs.openstack.org/admin-guide-cloud/content/
dashboard-sessions.html#dashboard-sessions>`__
in the `OpenStack Cloud Administrator Guide
<http://docs.openstack.org/admin-guide-cloud/content>`__
for information on user session data.
* To use the VNC client with the dashboard, the browser
must support HTML5 Canvas and HTML5 WebSockets.
For details about browsers that support noVNC, see
`README
<https://github.com/kanaka/noVNC/blob/master/README.md>`__
and `browser support
<https://github.com/kanaka/noVNC/wiki/Browser-support>`__.
dashboard-next-step.rst