openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
15,702 Commits 10 Branches 50 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
e0afd0d21d
Go to file
Akihiro Motoki e0afd0d21d [ussuri] [goal] Project PTL and contributor docs 
This commit updates the horizon contributor docs to follow
what the community goal [1] recommended.

* Reorganize doc/source/contributor/contributing.rst to the format
  suggested in the community goal template.
* Cleanup obsolete information and topics covered by the general
  OpenStack contributor guide.
* Move contributing.rst to the top in TOC of the contributor guide
  as it is considered as the entry point for new contributors.
* Sync CONTRIBUTING.rst at the top level directory with the
  community goal template.
* Update the core reviewer expectation along with PTL expectation.

[1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html

Story: #2007236
Task: #38525

Change-Id: Idce7fc08e7fdf854d8a7bca55169d18403362c45
2020-08-20 08:34:11 +09:00
.zuul.d Merge "Add plugin cross jobs" 2020-07-07 08:11:08 +00:00
doc [ussuri] [goal] Project PTL and contributor docs 2020-08-20 08:34:11 +09:00
horizon Imported Translations from Zanata 2020-07-27 06:56:20 +00:00
openstack_auth Fix template lookup errors on the login page 2020-05-18 16:05:11 +02:00
openstack_dashboard Merge "Revert "Add required mark on Create and Update image form"" 2020-08-19 14:16:17 +00:00
playbooks Fix horizon-nodejs10-run jobs 2020-06-19 15:37:06 +02:00
releasenotes Imported Translations from Zanata 2020-08-14 06:53:35 +00:00
roles Prepare non-primary Django tests in zuul jobs 2019-12-29 05:20:33 +09:00
tools Update plugin registry 2020-06-26 07:43:39 +00:00
.eslintignore bump eslint version to 1.10.3 2016-03-31 14:06:45 +00:00
.eslintrc Disabling warnings of 'quote-props' 2016-05-18 15:04:00 -06:00
.gitignore Change horizon test runner to pytest 2020-04-03 13:47:18 +03:00
.gitreview OpenDev Migration Patch 2019-04-19 19:37:19 +00:00
.mailmap Update my mailmap 2013-10-25 14:49:23 +08:00
.pylintrc Use the python real executable 2019-07-17 16:23:33 +02:00
babel-django.cfg Drop babel extractor definitions from babel config 2019-12-23 17:25:38 +09:00
babel-djangojs.cfg Drop babel extractor definitions from babel config 2019-12-23 17:25:38 +09:00
bindep.txt Fix video recording for integration tests 2020-04-09 09:20:04 +00:00
CONTRIBUTING.rst [ussuri] [goal] Project PTL and contributor docs 2020-08-20 08:34:11 +09:00
HACKING.rst Update the documentation link for doc migration 2017-08-04 18:38:25 +00:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
lower-constraints.txt Switch to newer openstackdocstheme and reno versions 2020-05-19 15:26:39 +00:00
manage.py hacking: noqa cleanup in horizon 2017-03-17 19:38:47 +00:00
MANIFEST.in Update MANIFEST for dashboard config 2020-06-08 15:06:58 +02:00
package.json Refactor tox & update docs 2016-11-30 20:38:59 +00:00
plugin-registry.csv Update plugin registry 2020-06-26 07:43:39 +00:00
README.rst Add release notes link in README 2018-07-10 14:45:26 +07:00
reno.yaml Tell reno to ignore the kilo branch 2020-03-23 13:18:58 +00:00
requirements.txt Bump xstatic-mdi lower-bound 2020-04-01 16:01:48 +09:00
setup.cfg Add py38 package metadata 2020-04-24 08:22:35 -05:00
setup.py Updated from global requirements 2017-05-30 13:34:43 +00:00
test-requirements.txt Fix hacking min version to 3.0.1 2020-05-13 15:51:32 +00:00
test-shim.js Add Apache 2.0 license to source file 2016-12-02 17:40:28 +07:00
tox.ini Bump default tox env from py37 to py38 2020-04-24 10:25:42 -05:00

README.rst

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.

image

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 docs

Results are in the doc/build/html directory