Move contents for README.rst
`include` directive on README.rst is not allowed on github. This patch switches the place of contents should be shown in README.rst. Change-Id: Ic688df6ec15b2c7bb260e0f59c2de683dd8e0f1b
This commit is contained in:
Shu Muto
parent
ac4730a2ee
commit
528f10b3c1
115
README.rst
115
README.rst
|
|
@ -13,11 +13,118 @@ Senlin Dashboard
|
|||
|
||||
Senlin Management Dashboard
|
||||
|
||||
.. include:: doc/source/contributor/hosts.rst
|
||||
.. inclusion-start-marker-hosts
|
||||
|
||||
.. include:: doc/source/install/index.rst
|
||||
Project Hosting
|
||||
---------------
|
||||
|
||||
.. include:: doc/source/contributor/develop.rst
|
||||
- Blueprints: https://blueprints.launchpad.net/senlin-dashboard
|
||||
- Bugs: https://bugs.launchpad.net/senlin-dashboard
|
||||
|
||||
.. include:: doc/source/configuration/index.rst
|
||||
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
|
||||
|
||||
.. inclusion-end-marker-hosts
|
||||
|
||||
.. inclusion-start-marker-install
|
||||
|
||||
============
|
||||
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.
|
||||
|
||||
.. inclusion-end-marker-install
|
||||
|
||||
.. inclusion-start-marker-develop
|
||||
|
||||
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
|
||||
#Enable senlin-dashboard
|
||||
enable_plugin senlin-dashboard https://git.openstack.org/openstack/senlin-dashboard
|
||||
|
||||
Please see the link： https://docs.openstack.org/senlin/latest/install/index.html
|
||||
for more detail about setting Senlin Server.
|
||||
|
||||
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
|
||||
|
||||
.. inclusion-end-marker-develop
|
||||
|
||||
.. inclusion-start-marker-configuration
|
||||
|
||||
=============
|
||||
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.
|
||||
|
||||
.. inclusion-end-marker-configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -12,9 +12,7 @@
|
|||
# limitations under the License.
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import warnings
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
# -- General configuration ----------------------------------------------------
|
||||
|
|
@ -61,16 +59,8 @@ html_theme = 'openstackdocs'
|
|||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '%sdoc' % project
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
# html_last_updated_fmt = '%b %d, %Y'
|
||||
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
|
||||
"-n1"]
|
||||
try:
|
||||
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
|
||||
except Exception:
|
||||
warnings.warn('Cannot get last updated time from git repository. '
|
||||
'Not setting "html_last_updated_fmt".')
|
||||
# Must set this variable to include year, month, day, hours, and minutes.
|
||||
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||
|
||||
# -- Options for openstackdocstheme -------------------------------------------
|
||||
repository_name = 'openstack/senlin-dashboard'
|
||||
|
|
|
|||
|
|
@ -1,17 +1,4 @@
|
|||
=============
|
||||
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.
|
||||
.. include:: ../../../README.rst
|
||||
:start-after: inclusion-start-marker-configuration
|
||||
:end-before: inclusion-end-marker-configuration
|
||||
|
||||
|
|
|
|||
|
|
@ -1,30 +1,4 @@
|
|||
Devstack Installation
|
||||
---------------------
|
||||
.. include:: ../../../README.rst
|
||||
:start-after: inclusion-start-marker-develop
|
||||
:end-before: inclusion-end-marker-develop
|
||||
|
||||
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
|
||||
#Enable senlin-dashboard
|
||||
enable_plugin senlin-dashboard https://git.openstack.org/openstack/senlin-dashboard
|
||||
|
||||
Please see the link： https://docs.openstack.org/senlin/latest/install/index.html
|
||||
for more detail about setting Senlin Server.
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -1,22 +1,4 @@
|
|||
Project Hosting
|
||||
---------------
|
||||
.. include:: ../../../README.rst
|
||||
:start-after: inclusion-start-marker-hosts
|
||||
:end-before: inclusion-end-marker-hosts
|
||||
|
||||
- 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,27 +1,4 @@
|
|||
============
|
||||
Installation
|
||||
============
|
||||
.. include:: ../../../README.rst
|
||||
:start-after: inclusion-start-marker-install
|
||||
:end-before: inclusion-end-marker-install
|
||||
|
||||
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.
|
||||
|
|
|
|||
Loading…
Reference in New Issue