Clean up doc/ and releasenotes/
Already we setup reno environment. So there were two Release notes information: doc/source/releases and releasenotes (by reno). Release Notes in doc directory are unnecessary. 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. Also version info is set in release notes. Change-Id: I0c2c31c9efc71d97ccea064da36302d886d8a743
This commit is contained in:
parent
9ac84cdc36
commit
45c763336f
@ -1,72 +1,28 @@
|
|||||||
==========
|
======
|
||||||
zun-ui
|
|
||||||
==========
|
|
||||||
|
|
||||||
Zun UI
|
Zun UI
|
||||||
|
======
|
||||||
|
|
||||||
|
Horizon plugin for Zun
|
||||||
|
|
||||||
* Free software: Apache license
|
* Free software: Apache license
|
||||||
* Source: https://git.openstack.org/cgit/openstack/zun-ui
|
* Source: https://git.openstack.org/cgit/openstack/zun-ui
|
||||||
* Bugs: https://bugs.launchpad.net/zun-ui
|
* Bugs: https://bugs.launchpad.net/zun-ui
|
||||||
|
|
||||||
Enabling in DevStack
|
Usage
|
||||||
--------------------
|
-----
|
||||||
|
|
||||||
Add this repo as an external repository into your ``local.conf`` file::
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
[[local|localrc]]
|
install
|
||||||
enable_plugin zun-ui https://github.com/openstack/zun-ui
|
|
||||||
|
|
||||||
Manual Installation
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Begin by cloning the Horizon and Zun UI repositories::
|
|
||||||
|
|
||||||
git clone https://github.com/openstack/horizon
|
|
||||||
git clone https://github.com/openstack/zun-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 Zun UI with all dependencies in your virtual environment::
|
|
||||||
|
|
||||||
tools/with_venv.sh pip install -e ../zun-ui/
|
|
||||||
|
|
||||||
And enable it in Horizon::
|
|
||||||
|
|
||||||
cp ../zun-ui/zun_ui/enabled/_1330_project_container_panelgroup.py openstack_dashboard/local/enabled
|
|
||||||
cp ../zun-ui/zun_ui/enabled/_1331_project_container_containers_panel.py openstack_dashboard/local/enabled
|
|
||||||
cp ../zun-ui/zun_ui/enabled/_2330_project_container_panelgroup.py openstack_dashboard/local/enabled
|
|
||||||
cp ../zun-ui/zun_ui/enabled/_2331_project_container_images_panel.py openstack_dashboard/local/enabled
|
|
||||||
|
|
||||||
To run horizon with the newly enabled Zun 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/
|
|
||||||
|
|
||||||
Release Notes
|
Release Notes
|
||||||
=============
|
-------------
|
||||||
|
|
||||||
https://docs.openstack.org/releasenotes/zun-ui
|
* https://docs.openstack.org/releasenotes/zun-ui
|
||||||
|
|
||||||
Source Code Reference
|
Source Code Reference
|
||||||
=====================
|
---------------------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:glob:
|
:glob:
|
||||||
|
55
doc/source/install.rst
Normal file
55
doc/source/install.rst
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
============
|
||||||
|
Installation
|
||||||
|
============
|
||||||
|
|
||||||
|
Enabling in DevStack
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
Add this repo as an external repository into your ``local.conf`` file::
|
||||||
|
|
||||||
|
[[local|localrc]]
|
||||||
|
enable_plugin zun-ui https://github.com/openstack/zun-ui
|
||||||
|
|
||||||
|
Manual Installation
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
Begin by cloning the Horizon and Zun UI repositories::
|
||||||
|
|
||||||
|
git clone https://github.com/openstack/horizon
|
||||||
|
git clone https://github.com/openstack/zun-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 Zun UI with all dependencies in your virtual environment::
|
||||||
|
|
||||||
|
tools/with_venv.sh pip install -e ../zun-ui/
|
||||||
|
|
||||||
|
And enable it in Horizon::
|
||||||
|
|
||||||
|
cp ../zun-ui/zun_ui/enabled/_1330_project_container_panelgroup.py openstack_dashboard/local/enabled
|
||||||
|
cp ../zun-ui/zun_ui/enabled/_1331_project_container_containers_panel.py openstack_dashboard/local/enabled
|
||||||
|
cp ../zun-ui/zun_ui/enabled/_2330_project_container_panelgroup.py openstack_dashboard/local/enabled
|
||||||
|
cp ../zun-ui/zun_ui/enabled/_2331_project_container_images_panel.py openstack_dashboard/local/enabled
|
||||||
|
|
||||||
|
To run horizon with the newly enabled Zun 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/
|
@ -1,2 +0,0 @@
|
|||||||
Zun UI 0.1.0
|
|
||||||
============
|
|
@ -40,7 +40,7 @@ extensions = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates']
|
# templates_path = ['_templates']
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
@ -138,7 +138,7 @@ html_theme = 'default'
|
|||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# 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,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# 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
|
# Add any extra paths that contain custom files (such as robots.txt or
|
||||||
# .htaccess) here, relative to this directory. These files are copied
|
# .htaccess) here, relative to this directory. These files are copied
|
||||||
|
Loading…
Reference in New Issue
Block a user