From 83caa004e25be7448e43031d6e886dd1f0182654 Mon Sep 17 00:00:00 2001 From: Shu Muto Date: Tue, 27 Jun 2017 16:26:02 +0900 Subject: [PATCH] Clean up doc/ and releasenotes/ It is not a good idea to have too much contents in the top page document. Installation stuff is split into a separate page. Title level of index.rst was inconsistent. _static and _templates directories in releasenotes/source are unnecessary. Change-Id: I005d6d110de986773ae8149d2170840f0fe02e4f --- doc/source/index.rst | 63 +++------------------ doc/source/install.rst | 54 ++++++++++++++++++ releasenotes/source/_static/.placeholder | 0 releasenotes/source/_templates/.placeholder | 0 releasenotes/source/conf.py | 4 +- 5 files changed, 65 insertions(+), 56 deletions(-) create mode 100644 doc/source/install.rst delete mode 100644 releasenotes/source/_static/.placeholder delete mode 100644 releasenotes/source/_templates/.placeholder diff --git a/doc/source/index.rst b/doc/source/index.rst index d9565b60..02332145 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,5 +1,5 @@ ========= -Magnum-UI +Magnum UI ========= Horizon plugin for Magnum @@ -8,69 +8,24 @@ Horizon plugin for Magnum * Source: http://git.openstack.org/cgit/openstack/magnum-ui * Bugs: http://bugs.launchpad.net/magnum-ui -Enabling in DevStack -==================== +Usage +----- -Add this repo as an external repository into your ``local.conf`` file:: +.. toctree:: + :maxdepth: 1 - [[local|localrc]] - enable_plugin magnum-ui https://github.com/openstack/magnum-ui - -Manual Installation -=================== - -Begin by cloning the Horizon and Magnum UI repositories:: - - git clone https://github.com/openstack/horizon - git clone https://github.com/openstack/magnum-ui - -Create a virtual environment and install Horizon dependencies:: - - cd horizon - python tools/install_venv.py - -Set up your ``local_settings.py`` file:: - - cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py - -Open up the copied ``local_settings.py`` file in your preferred text -editor. You will want to customize several settings: - -- ``OPENSTACK_HOST`` should be configured with the hostname 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 Magnum UI with all dependencies in your virtual environment:: - - tools/with_venv.sh pip install -e ../magnum-ui/ - -And enable it in Horizon:: - - cp ../magnum-ui/magnum_ui/enabled/_1370_project_container_infra_panelgroup.py openstack_dashboard/local/enabled - cp ../magnum-ui/magnum_ui/enabled/_1371_project_container_infra_clusters_panel.py openstack_dashboard/local/enabled - cp ../magnum-ui/magnum_ui/enabled/_1372_project_container_infra_cluster_templates_panel.py openstack_dashboard/local/enabled - -To run horizon with the newly enabled Magnum UI plugin run:: - - python manage.py runserver 0.0.0.0:8080 - -to have the application start on port 8080 and the horizon dashboard will be -available in your browser at http://localhost:8080/ + install Release Notes -============= +------------- -* http://docs.openstack.org/releasenotes/magnum-ui/ +* https://docs.openstack.org/releasenotes/magnum-ui/ Source Code Reference -===================== +--------------------- .. toctree:: :glob: :maxdepth: 1 sourcecode/autoindex - - diff --git a/doc/source/install.rst b/doc/source/install.rst new file mode 100644 index 00000000..9a45c625 --- /dev/null +++ b/doc/source/install.rst @@ -0,0 +1,54 @@ +============ +Installation +============ + +Enabling in DevStack +-------------------- + +Add this repo as an external repository into your ``local.conf`` file:: + + [[local|localrc]] + enable_plugin magnum-ui https://github.com/openstack/magnum-ui + +Manual Installation +------------------- + +Begin by cloning the Horizon and Magnum UI repositories:: + + git clone https://github.com/openstack/horizon + git clone https://github.com/openstack/magnum-ui + +Create a virtual environment and install Horizon dependencies:: + + cd horizon + python tools/install_venv.py + +Set up your ``local_settings.py`` file:: + + cp openstack_dashboard/local/local_settings.py.example openstack_dashboard/local/local_settings.py + +Open up the copied ``local_settings.py`` file in your preferred text +editor. You will want to customize several settings: + +- ``OPENSTACK_HOST`` should be configured with the hostname 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 Magnum UI with all dependencies in your virtual environment:: + + tools/with_venv.sh pip install -e ../magnum-ui/ + +And enable it in Horizon:: + + cp ../magnum-ui/magnum_ui/enabled/_1370_project_container_infra_panelgroup.py openstack_dashboard/local/enabled + cp ../magnum-ui/magnum_ui/enabled/_1371_project_container_infra_clusters_panel.py openstack_dashboard/local/enabled + cp ../magnum-ui/magnum_ui/enabled/_1372_project_container_infra_cluster_templates_panel.py openstack_dashboard/local/enabled + +To run horizon with the newly enabled Magnum UI plugin run:: + + python manage.py runserver 0.0.0.0:8080 + +to have the application start on port 8080 and the horizon dashboard will be +available in your browser at http://localhost:8080/ diff --git a/releasenotes/source/_static/.placeholder b/releasenotes/source/_static/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/releasenotes/source/_templates/.placeholder b/releasenotes/source/_templates/.placeholder deleted file mode 100644 index e69de29b..00000000 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index e49616f4..4fd83cbe 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -40,7 +40,7 @@ extensions = [ ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +# templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' @@ -138,7 +138,7 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = [''] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied