diff --git a/README.rst b/README.rst index d690a55a..6491c076 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ 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. * Free software: Apache license @@ -20,10 +20,9 @@ Features 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 +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: @@ -35,26 +34,26 @@ html `source .venv/bin/activate` -3. Copy the _2200_ironic.py file from ironic-ui/enabled directory to +3. Copy the _2200_ironic.py file from ironic-ui/enabled directory to horizon/openstack_dashboard/local/enabled 4. Change into the ironic-ui repository and package the plugin: `pip install -e .` -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. +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. Also ensure that all packages as per requirements.txt have been installed. 5. Change back into the horizon repository and bring up your environment: - + `./run_tests.sh --runserver` -The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon +The Ironic Bare Metal Provisioning plugin should now be visible in the Horizon navigation. 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 +running pip list from inside the horizon .venv). You will also need to remove the enabled file from the openstack_dashboard/enabled folder.