horizon-cisco-ui/README.rst

Team and repository tags

Cisco UI: Cisco Extension for the OpenStack Dashboard (Horizon)

• Release management: https://launchpad.net/horizon-cisco-ui
• Blueprints and feature specifications: https://blueprints.launchpad.net/horizon-cisco-ui
• Issue tracking: https://bugs.launchpad.net/horizon-cisco-ui

Cisco UI is a Horizon Dashboard for interacting with Cisco Systems hardware. It uses the standard Horizon extension systems, and maintains code and styling consistency where possible.

Most of the developer information, as well as an overview of Horizon, can be found in the Horizon documentation online.

Getting Started

The quickest way to get up and running is:

1. Setup a basic Devstack installation
2. Clone Cisco UI with git clone https://github.com/openstack/horizon-cisco-ui
3. Enter the horizon-cisco-ui directory, and run ./dev_install.sh. Follow the on screen instructions. Often the default settings will be adequate, so you can just hit enter twice.

Building Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the doc/source directory using reStructuredText and built by Sphinx

• Building Automatically:

  $ ./run_tests.sh --docs

• Building Manually:

  $ tools/with_venv.sh sphinx-build doc/source doc/build/html

Results are in the doc/build/html directory