From ae2172f511c14dbd3e06222382e65dfc774f131b Mon Sep 17 00:00:00 2001 From: Elizabeth Elwell Date: Thu, 2 Jun 2016 11:21:10 +0100 Subject: [PATCH] Updated ironic-ui documentation Updated developer documentation to include introduction to the ironic-ui and links to other relevant docs. Change-Id: I82086e0c9e8011cfcaa13d4057ab2f828c1c0515 --- doc/source/contributing.rst | 54 ++++++++++++++++++++++++++++++++++--- doc/source/index.rst | 48 +++++++++++++++++++-------------- doc/source/installation.rst | 44 ++++++++++++++++++++++++------ 3 files changed, 114 insertions(+), 32 deletions(-) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 1728a61c..13b4f64f 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1,4 +1,50 @@ -============ -Contributing -============ -.. include:: ../../CONTRIBUTING.rst +.. _contributing: + +========================= +Contributing to Ironic UI +========================= + +If you're interested in contributing to the Ironic UI project, +the following will help get you started. + +Contributor License Agreement +----------------------------- + +.. index:: + single: license; agreement + +In order to contribute to the Ironic project, you need to have +signed OpenStack's contributor's agreement. + +.. seealso:: + + * http://docs.openstack.org/infra/manual/developers.html + * http://wiki.openstack.org/CLA + +LaunchPad Project +----------------- + +Most of the tools used for OpenStack depend on a launchpad.net ID for +authentication. + +.. seealso:: + + * https://launchpad.net + * https://launchpad.net/ironic + +Project Hosting Details +------------------------- + +Bug tracker + http://launchpad.net/ironic-ui + +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 + +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 1d2fb55e..b5e78c7a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,25 +1,33 @@ -.. ironic-ui documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +=============================================== +Welcome to Ironic UI's developer documentation! +=============================================== -Welcome to ironic-ui's documentation! -======================================================== +Introduction +============ -Contents: +The ironic UI is an OpenStack Horizon plugin that will allow users to view and +manage their ironic bare metal nodes, ports and drivers. + +The documentation provided here is continually kept up-to-date based +on the latest code that has been committed, and may not represent the state of +the project at any specific prior release. + +For information on any current or prior version of Ironic, see `the release +notes`_. + +.. _the release notes: http://docs.openstack.org/releasenotes/ironic-ui/ + +For more information on ironic, see `the ironic documentation`_. + +.. _the ironic documentation: http://docs.openstack.org/developer/ironic/ + +Administrator's Guide +===================== .. toctree:: - :maxdepth: 2 - - readme - installation - usage - contributing - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + :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 9a54eb8c..f8c9d0e3 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -1,12 +1,40 @@ -============ -Installation -============ +.. _installation: -At the command line:: +====================== +Ironic-UI Installation +====================== - $ pip install ironic-ui +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 -Or, if you have virtualenvwrapper installed:: +1. Clone Ironic UI repository: - $ mkvirtualenv ironic-ui - $ pip install 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 + + `source .venv/bin/activate` + +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 -r requirements.txt -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. + +5. Change back into the horizon repository and bring up your environment: + + `./run_tests.sh --runserver` + +The Bare Metal service 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 +the enabled file from the openstack_dashboard/enabled folder.