Clean up doc/ and releasenotes/

There were two Release notes information: doc/source/releases and
releasenotes (by reno). There is no need to have two different way.

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: I26675254f3480330f00e210e3345c7db6ea5b2b2
This commit is contained in:
Akihiro Motoki 2017-05-26 16:10:00 +09:00
parent ffe0ddcdb2
commit 431ce21bec
7 changed files with 69 additions and 70 deletions

View File

@ -13,72 +13,19 @@ Features
* TODO
Enabling in DevStack
--------------------
Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin {{ cookiecutter.module_name }} https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}
Manual Installation
-------------------
Begin by cloning the Horizon and {{ cookiecutter.call_by_name }} repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}
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 {{ cookiecutter.call_by_name }} with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../{{ cookiecutter.repo_name }}/
And enable it in Horizon::
ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_90_project_{{ cookiecutter.panel_group }}_panelgroup.py openstack_dashboard/local/enabled
ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_91_project_{{ cookiecutter.panel_group }}_{{ cookiecutter.panel }}s_panel.py openstack_dashboard/local/enabled
To run horizon with the newly enabled {{ cookiecutter.call_by_name }} plugin run::
./run_tests.sh --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
=============
Using {{ cookiecutter.call_by_name }}
-------------------------------------
.. toctree::
:glob:
:maxdepth: 1
:maxdepth: 1
releases/*
install
Source Code Reference
=====================
---------------------
.. toctree::
:glob:
:maxdepth: 1
sourcecode/autoindex
:glob:
:maxdepth: 1
sourcecode/autoindex

View File

@ -0,0 +1,53 @@
============
Installation
============
Enabling in DevStack
--------------------
Add this repo as an external repository into your ``local.conf`` file::
[[local|localrc]]
enable_plugin {{ cookiecutter.module_name }} https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}
Manual Installation
-------------------
Begin by cloning the Horizon and {{ cookiecutter.call_by_name }} repositories::
git clone https://github.com/openstack/horizon
git clone https://github.com/{{ cookiecutter.repo_group }}/{{ cookiecutter.repo_name }}
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 {{ cookiecutter.call_by_name }} with all dependencies in your virtual environment::
tools/with_venv.sh pip install -e ../{{ cookiecutter.repo_name }}/
And enable it in Horizon::
ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_90_project_{{ cookiecutter.panel_group }}_panelgroup.py openstack_dashboard/local/enabled
ln -s ../{{ cookiecutter.repo_name }}/{{ cookiecutter.module_name }}/enabled/_91_project_{{ cookiecutter.panel_group }}_{{ cookiecutter.panel }}s_panel.py openstack_dashboard/local/enabled
To run horizon with the newly enabled {{ cookiecutter.call_by_name }} plugin run::
./run_tests.sh --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/

View File

@ -1,2 +0,0 @@
{{ cookiecutter.call_by_name }} 0.1.0
===============================

View File

@ -43,7 +43,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'
@ -62,11 +62,12 @@ copyright = u'2016, OpenStack Foundation'
# |version| and |release|, also used in various other places throughout the
# built documents.
#
from {{cookiecutter.module_name}} import version as ui_ver
# The short X.Y version.
# The full version, including alpha/beta/rc tags.
release = ''
release = ui_ver.version_info.release_string()
# The short X.Y version.
version = ''
version = ui_ver.version_info.version_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@ -140,7 +141,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

View File

@ -1,6 +1,6 @@
============================================
{{cookiecutter.module_name}} Release Notes
============================================
==========================================
{{cookiecutter.module_name}} Release Notes
==========================================
.. toctree::
:maxdepth: 1