Ana Krivokapic 288a6ee498 Improve developer documentation

* Merge docs/index.rst into README.rst
* Leave only a short introduction and links to other doc pages
  in docs/index.rst
* Add a link to https://wiki.openstack.org/wiki/Tuskar/Devtest
* Fix 404 links
* Fix inconsistencies in the spelling of 'Tuskar UI'
* Fix typos

Change-Id: Iafa76efdb22043434cf3879d722d9ddcccd807d4

2014-04-23 11:36:09 +02:00

2.1 KiB

Raw Blame History

Tuskar UI

Tuskar UI is a user interface for Tuskar, a management API for OpenStack deployments. It is a plugin for OpenStack Horizon.

High-Level Overview

Tuskar UI endeavours to be a stateless UI, relying on Tuskar API calls as much as possible. We use existing Horizon libraries and components where possible. If added libraries and components are needed, we will work with the OpenStack community to push those changes back into Horizon.

Interested in seeing Tuskar and Tuskar UI in action? Watch a demo!

Contributing

The code repository is located at OpenStack. Please go there if you want to check it out:

git clone https://github.com/openstack/tuskar-ui.git

The list of bugs and blueprints is on Launchpad:

https://launchpad.net/tuskar-ui

We use OpenStack's Gerrit for the code contributions:

https://review.openstack.org/#/q/status:open+project:openstack/tuskar-ui,n,z

and we follow the OpenStack Gerrit Workflow.

If you're interested in the code, here are some key places to start:

tuskar_ui/api.py

- This file contains all the API calls made to the Tuskar API (through python-tuskarclient).
tuskar_ui/infrastructure
- The Tuskar UI code is contained within this directory.

Installation Guide

Use the Installation Guide to install Tuskar UI.

License

This project is licensed under the Apache License, version 2. More information can be found in the LICENSE file.

Contact Us

Join us on IRC (Internet Relay Chat):

Network: Freenode (irc.freenode.net/tuskar)
Channel: #tuskar

Or send an email to openstack-dev@lists.openstack.org.

2.1 KiB Raw Blame History