c897a8e444
Ussuri community goal "Project specific contributor and PTL docs" want us to use doc/source/contributor/contributing.rst as an entry point, but the current contributor/contributing.rst in horizon contains a lot of information. Before updating the file to satisfy the community goal criteria, this commit reorganize the contributor doc. It splits the existing contents in contributing.rst into pieces. Change-Id: I8aa9a310a99e0eed5a93ed040a02a2829ee09bf7
Horizon (OpenStack Dashboard)
Horizon is a Django-based project aimed at providing a complete
OpenStack Dashboard along with an extensible framework for building new
dashboards from reusable components. The
openstack_dashboard module is a reference implementation of
a Django site that uses the horizon app to provide
web-based interactions with the various OpenStack projects.
- Project documentation: https://docs.openstack.org/horizon/latest/
- Release management: https://launchpad.net/horizon
- Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
- Issue tracking: https://bugs.launchpad.net/horizon
- Release notes: https://docs.openstack.org/releasenotes/horizon/
Using Horizon
See doc/source/install/index.rst about how to install
Horizon in your OpenStack setup. It describes the example steps and has
pointers for more detailed settings and configurations.
It is also available at Installation Guide.
Getting Started for Developers
doc/source/quickstart.rst or Quickstart
Guide describes how to setup Horizon development environment and
start development.
Building Contributor Documentation
This documentation is written by contributors, for contributors.
The source is maintained in the doc/source directory
using reStructuredText and
built by Sphinx
To build the docs, use:
$ tox -e docsResults are in the doc/build/html directory