From 8d6fcd819c6946d425325e180593d50f2e3c23eb Mon Sep 17 00:00:00 2001 From: Julia Kreger Date: Fri, 9 Dec 2016 15:44:35 +0000 Subject: [PATCH] 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 --- README.rst | 59 ++++++++++++++++++++++--------------- doc/source/contributing.rst | 2 +- doc/source/index.rst | 1 - doc/source/installation.rst | 48 ++++++++++++++++++------------ doc/source/readme.rst | 1 - doc/source/usage.rst | 7 ----- 6 files changed, 65 insertions(+), 53 deletions(-) delete mode 100644 doc/source/readme.rst delete mode 100644 doc/source/usage.rst diff --git a/README.rst b/README.rst index f974c41d..4d36149b 100644 --- a/README.rst +++ b/README.rst @@ -7,9 +7,9 @@ Team and repository tags .. Change things from this point on -=============================== +========= Ironic UI -=============================== +========= The Ironic UI is a Horizon plugin that will allow users to view and manage bare metal nodes, ports and drivers. @@ -31,38 +31,49 @@ Installation Instructions Please note that the following instructions assume that you have an existing 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. - NOTE: this has been preinstalled when horizon was setup with ./run_tests.sh - - do not reinstall venv +2. Change into the root directory of your horizon installation and + activate the python virtual environment. Example:: - `source .venv/bin/activate` + source .venv/bin/activate -3. Copy the _2200_ironic.py file from ironic_ui/enabled directory to -horizon/openstack_dashboard/local/enabled + .. NOTE:: The ``.venv`` folder is preinstalled when horizon is setup with + ``./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 -environment associated with your horizon installation. The plugin is installed -in "editable" mode as a link back to your ironic-ui plugin directory. +4. Change into the ironic-ui repository and package the plugin:: -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 -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 -running pip list from inside the horizon .venv). You will also need to remove -the enabled file from the openstack_dashboard/enabled folder. + ./run_tests.sh --runserver + + 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. diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 13b4f64f..ceac405b 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -42,7 +42,7 @@ Mailing list (prefix subjects with ``[ironic-ui]`` for faster responses) http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev Code Hosting - https://github.com/openstack/ironic-ui + https://git.openstack.org/cgit/openstack/ironic-ui Code Review https://review.openstack.org/#/q/status:open+project:openstack/ironic-ui,n,z diff --git a/doc/source/index.rst b/doc/source/index.rst index c9c84bfd..c082cf82 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -27,7 +27,6 @@ Administrator's Guide .. toctree:: :maxdepth: 1 - Introduction to ironic UI Introduction to ironic Installing the ironic UI Contributing diff --git a/doc/source/installation.rst b/doc/source/installation.rst index e02dc962..adb70ad9 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -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 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. - NOTE: this has been preinstalled when horizon was setup with ./run_tests.sh - - do not reinstall venv +2. Change into the root directory of your horizon installation and + activate the python virtualenv. Example:: - `source .venv/bin/activate` + source .venv/bin/activate -3. Copy the _2200_ironic.py file from ironic_ui/enabled directory to -horizon/openstack_dashboard/local/enabled + .. NOTE:: The ``.venv`` folder is pre-installed when horizon is setup with + ``./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 -environment associated with your horizon installation. The plugin is installed -in "editable" mode as a link back to your ironic-ui plugin directory. +4. Change into the ironic-ui repository and package the plugin:: -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 -running pip list from inside the horizon .venv). You will also need to remove -the enabled file from the openstack_dashboard/enabled folder. + ./run_tests.sh --runserver + + 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. diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3d..00000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst diff --git a/doc/source/usage.rst b/doc/source/usage.rst deleted file mode 100644 index bc71b968..00000000 --- a/doc/source/usage.rst +++ /dev/null @@ -1,7 +0,0 @@ -======== -Usage -======== - -To use ironic-ui in a project:: - - import ironic-ui