Refactor ironic-ui documentation to remove warnings
Warnings, such as those caused by the README.rst file's inclusion of an externally hosted file cause the default sphinx job to fail. Removed the link, and cleaned up the documentation formatting to make it more clear moving forward. Change-Id: I55afe786b794a6cb179a3de20b5f4e0f3f8072c8
This commit is contained in:
Julia Kreger
parent
39eff39501
commit
8d6fcd819c
59
README.rst
59
README.rst
@ -7,9 +7,9 @@ Team and repository tags
|
|||||||
|
|
||||||
.. Change things from this point on
|
.. Change things from this point on
|
||||||
|
|
||||||
===============================
|
=========
|
||||||
Ironic UI
|
Ironic UI
|
||||||
===============================
|
=========
|
||||||
|
|
||||||
The Ironic UI is a Horizon plugin that will allow users to view and manage bare
|
The Ironic UI is a Horizon plugin that will allow users to view and manage bare
|
||||||
metal nodes, ports and drivers.
|
metal nodes, ports and drivers.
|
||||||
@ -31,38 +31,49 @@ Installation Instructions
|
|||||||
|
|
||||||
Please note that the following instructions assume that you have an existing
|
Please note that the following instructions assume that you have an existing
|
||||||
installation of the OpenStack Horizon dashboard application. For Horizon
|
installation of the OpenStack Horizon dashboard application. For Horizon
|
||||||
installation please see http://docs.openstack.org/developer/horizon/quickstart.html
|
installation please see
|
||||||
|
http://docs.openstack.org/developer/horizon/quickstart.html
|
||||||
|
|
||||||
1. Clone Ironic UI repository:
|
1. Clone the Ironic UI repository::
|
||||||
|
|
||||||
`git clone https://git.openstack.org/openstack/ironic-ui`
|
git clone https://git.openstack.org/openstack/ironic-ui
|
||||||
|
|
||||||
2. Change into the root directory of your horizon installation and run the venv.
|
2. Change into the root directory of your horizon installation and
|
||||||
NOTE: this has been preinstalled when horizon was setup with ./run_tests.sh -
|
activate the python virtual environment. Example::
|
||||||
do not reinstall venv
|
|
||||||
|
|
||||||
`source .venv/bin/activate`
|
source .venv/bin/activate
|
||||||
|
|
||||||
3. Copy the _2200_ironic.py file from ironic_ui/enabled directory to
|
.. NOTE:: The ``.venv`` folder is preinstalled when horizon is setup with
|
||||||
horizon/openstack_dashboard/local/enabled
|
``./run_tests.sh``. Do not attempt to reinstall the virtual
|
||||||
|
environment.
|
||||||
|
|
||||||
4. Change into the ironic-ui repository and package the plugin:
|
3. Copy the ``_2200_ironic.py`` file from ``ironic_ui/enabled/_2200_ironic.py`` file to
|
||||||
|
``horizon/openstack_dashboard/local/enabled`` directory. Example, set as if being
|
||||||
|
executed from the root of the ironic-ui repository::
|
||||||
|
|
||||||
`pip install -e .`
|
cp ./ironic_ui/enabled/_2200_ironic.py ../horizon/horizon/openstack_dashboard/local/enabled
|
||||||
|
|
||||||
This will build and install the ironic-ui plugin into the active virtual
|
4. Change into the ironic-ui repository and package the plugin::
|
||||||
environment associated with your horizon installation. The plugin is installed
|
|
||||||
in "editable" mode as a link back to your ironic-ui plugin directory.
|
|
||||||
|
|
||||||
Also ensure that all packages as per requirements.txt have been installed.
|
pip install -e .
|
||||||
|
|
||||||
5. Change back into the horizon repository and bring up your environment:
|
This will build and install the ironic-ui plugin into the active virtual
|
||||||
|
environment associated with your horizon installation. The plugin is installed
|
||||||
|
in "editable" mode as a link back to your ironic-ui plugin directory.
|
||||||
|
|
||||||
`./run_tests.sh --runserver`
|
Also ensure that all packages as per requirements.txt have been installed.
|
||||||
|
|
||||||
The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon
|
5. Change back into the horizon repository and bring up your environment::
|
||||||
navigation.
|
|
||||||
|
|
||||||
To uninstall, use pip uninstall (find the name of the package to uninstall by
|
./run_tests.sh --runserver
|
||||||
running pip list from inside the horizon .venv). You will also need to remove
|
|
||||||
the enabled file from the openstack_dashboard/enabled folder.
|
The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon
|
||||||
|
navigation.
|
||||||
|
|
||||||
|
Uninstallation
|
||||||
|
--------------
|
||||||
|
|
||||||
|
To uninstall, use ``pip uninstall ironic-ui`` from with-in the horizon
|
||||||
|
virtual environment. You will also need to remove the
|
||||||
|
``openstack_dashboard/enabled/_2200_ironic.py`` file from the horizon
|
||||||
|
installation.
|
||||||
|
|||||||
@ -42,7 +42,7 @@ Mailing list (prefix subjects with ``[ironic-ui]`` for faster responses)
|
|||||||
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
|
||||||
|
|
||||||
Code Hosting
|
Code Hosting
|
||||||
https://github.com/openstack/ironic-ui
|
https://git.openstack.org/cgit/openstack/ironic-ui
|
||||||
|
|
||||||
Code Review
|
Code Review
|
||||||
https://review.openstack.org/#/q/status:open+project:openstack/ironic-ui,n,z
|
https://review.openstack.org/#/q/status:open+project:openstack/ironic-ui,n,z
|
||||||
|
|||||||
@ -27,7 +27,6 @@ Administrator's Guide
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
Introduction to ironic UI <readme>
|
|
||||||
Introduction to ironic <http://docs.openstack.org/developer/ironic/deploy/user-guide.html>
|
Introduction to ironic <http://docs.openstack.org/developer/ironic/deploy/user-guide.html>
|
||||||
Installing the ironic UI <installation>
|
Installing the ironic UI <installation>
|
||||||
Contributing <contributing>
|
Contributing <contributing>
|
||||||
|
|||||||
@ -8,33 +8,43 @@ Please note that the following instructions assume that you have an existing
|
|||||||
installation of the OpenStack Horizon dashboard application. For Horizon
|
installation of the OpenStack Horizon dashboard application. For Horizon
|
||||||
installation please see http://docs.openstack.org/developer/horizon/quickstart.html
|
installation please see http://docs.openstack.org/developer/horizon/quickstart.html
|
||||||
|
|
||||||
1. Clone Ironic UI repository:
|
1. Clone the Ironic UI repository::
|
||||||
|
|
||||||
`git clone https://git.openstack.org/openstack/ironic-ui`
|
git clone https://git.openstack.org/openstack/ironic-ui
|
||||||
|
|
||||||
2. Change into the root directory of your horizon installation and run the venv.
|
2. Change into the root directory of your horizon installation and
|
||||||
NOTE: this has been preinstalled when horizon was setup with ./run_tests.sh -
|
activate the python virtualenv. Example::
|
||||||
do not reinstall venv
|
|
||||||
|
|
||||||
`source .venv/bin/activate`
|
source .venv/bin/activate
|
||||||
|
|
||||||
3. Copy the _2200_ironic.py file from ironic_ui/enabled directory to
|
.. NOTE:: The ``.venv`` folder is pre-installed when horizon is setup with
|
||||||
horizon/openstack_dashboard/local/enabled
|
``./run_tests.sh``. Do not attempt to reinstall the virtual
|
||||||
|
environment.
|
||||||
|
|
||||||
4. Change into the ironic-ui repository and package the plugin:
|
3. Copy the ``_2200_ironic.py`` file from ``ironic_ui/enabled/_2200_ironic.py``
|
||||||
|
file to ``horizon/openstack_dashboard/local/enabled`` directory. Example,
|
||||||
|
set as if being executed from the root of the ironic-ui repository::
|
||||||
|
|
||||||
`pip install -r requirements.txt -e .`
|
cp ./ironic_ui/enabled/_2200_ironic.py ../horizon/horizon/openstack_dashboard/local/enabled
|
||||||
|
|
||||||
This will build and install the ironic-ui plugin into the active virtual
|
4. Change into the ironic-ui repository and package the plugin::
|
||||||
environment associated with your horizon installation. The plugin is installed
|
|
||||||
in "editable" mode as a link back to your ironic-ui plugin directory.
|
|
||||||
|
|
||||||
5. Change back into the horizon repository and bring up your environment:
|
pip install -r requirements.txt -e .
|
||||||
|
|
||||||
`./run_tests.sh --runserver`
|
This will build and install the ironic-ui plugin into the active virtual
|
||||||
|
environment associated with your horizon installation. The plugin is installed
|
||||||
|
in "editable" mode as a link back to your ironic-ui plugin directory.
|
||||||
|
|
||||||
The Bare Metal service should now be visible in the Horizon navigation.
|
5. Change back into the horizon repository and bring up your environment::
|
||||||
|
|
||||||
To uninstall, use pip uninstall (find the name of the package to uninstall by
|
./run_tests.sh --runserver
|
||||||
running pip list from inside the horizon .venv). You will also need to remove
|
|
||||||
the enabled file from the openstack_dashboard/enabled folder.
|
The Bare Metal service should now be visible in the Horizon navigation.
|
||||||
|
|
||||||
|
Uninstallation
|
||||||
|
--------------
|
||||||
|
|
||||||
|
To uninstall, use ``pip uninstall ironic-ui`` from with-in the horizon
|
||||||
|
virtual environment. You will also need to remove the
|
||||||
|
``openstack_dashboard/enabled/_2200_ironic.py`` file from the horizon
|
||||||
|
installation.
|
||||||
|
|||||||
@ -1 +0,0 @@
|
|||||||
.. include:: ../../README.rst
|
|
||||||
@ -1,7 +0,0 @@
|
|||||||
========
|
|
||||||
Usage
|
|
||||||
========
|
|
||||||
|
|
||||||
To use ironic-ui in a project::
|
|
||||||
|
|
||||||
import ironic-ui
|
|
||||||
Loading…
Reference in New Issue
Block a user