horizon-cisco-ui/README.rst
Rob Cresswell 86b0bce8cf Initial commit
This patch adds the core panels (Cisco Dashboard and Firewalls),
dev install script, basic documentation, and testing.

There is a fairly large amount of extra "stuff" left in, due to the
copy/paste nature of the setup. Specifically, the tests have a lot of
the horizon test code in which is unecessary, but temporary with the aim
of getting up and running quickly.

Change-Id: I5fdce186df09e1168e8d52abfec17e0c20a64031
Partially-Implements: blueprint initial-setup
2015-08-18 14:33:52 +01:00

1.8 KiB

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

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