openstack/horizon
Code Issues Proposed changes
738cdf26ef
horizon/README.rst

52 lines
1.7 KiB
ReStructuredText
Raw Normal View History

Unifies the project packaging into one set of modules. There are no longer two separate projects living inside the horizon repository. There is a single project now with a single setup.py, single README, etc. The openstack-dashboard/dashboard django project is now named "openstack_dashboard" and lives as an example project in the topmost horizon directory. The "horizon/horizon" directory has been bumped up a level and now is directly on the path when the root horizon directory is on your python path. Javascript media which the horizon module directly relies upon now ships in the horizon/static dir rather than openstack-dashboard/dashboard/static. All the corresponding setup, installation, build, and env scripts have been updated accordingly. Implements blueprint unified-packaging. Change-Id: Ieed8e3c777432cd046c3e0298869a9428756ab62
2012-02-28 23:27:46 -08:00
=============================
Horizon (OpenStack Dashboard)
=============================
Combined django-nova and openstack-dashboard
2011-03-03 23:41:53 -08:00
Unifies the project packaging into one set of modules. There are no longer two separate projects living inside the horizon repository. There is a single project now with a single setup.py, single README, etc. The openstack-dashboard/dashboard django project is now named "openstack_dashboard" and lives as an example project in the topmost horizon directory. The "horizon/horizon" directory has been bumped up a level and now is directly on the path when the root horizon directory is on your python path. Javascript media which the horizon module directly relies upon now ships in the horizon/static dir rather than openstack-dashboard/dashboard/static. All the corresponding setup, installation, build, and env scripts have been updated accordingly. Implements blueprint unified-packaging. Change-Id: Ieed8e3c777432cd046c3e0298869a9428756ab62
2012-02-28 23:27:46 -08:00
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.
Updated README
2011-06-17 23:35:00 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
* Release management: https://launchpad.net/horizon
* Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
* Issue tracking: https://bugs.launchpad.net/horizon
Updated README
2011-06-17 23:35:00 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
Using Horizon
=============
Updated README
2011-06-17 23:35:00 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
See ``doc/source/topics/install.rst`` about how to install Horizon
in your OpenStack setup. It describes the example steps and
has pointers for more detailed settings and configurations.
Updated README
2011-06-17 23:35:00 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
It is also available at http://docs.openstack.org/developer/horizon/topics/install.html.
Updated README
2011-06-17 23:35:00 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
Getting Started for Developers
==============================
updating README to explain project/repo structure
2011-08-31 16:33:44 -07:00
Add install guide for users and clean up README * Add "Using Horizon" section to the docs, which describes how to install and configure Horizon. It is for operators who install Horizon from source code. * Clean up README.rst as much of the information is out-of-date and most of it is covered by the developer docs. * Minor update of page titles. Change-Id: I09aab0d0bc47e07c8d663e7f7b5801e456434950
2014-10-05 06:53:38 +09:00
``doc/source/quickstart.rst`` or
http://docs.openstack.org/developer/horizon/quickstart.html
describes how to setup Horizon development environment and start development.
adding developer docs
2011-10-27 10:52:33 -07:00
Building Contributor Documentation
Unifies the project packaging into one set of modules. There are no longer two separate projects living inside the horizon repository. There is a single project now with a single setup.py, single README, etc. The openstack-dashboard/dashboard django project is now named "openstack_dashboard" and lives as an example project in the topmost horizon directory. The "horizon/horizon" directory has been bumped up a level and now is directly on the path when the root horizon directory is on your python path. Javascript media which the horizon module directly relies upon now ships in the horizon/static dir rather than openstack-dashboard/dashboard/static. All the corresponding setup, installation, build, and env scripts have been updated accordingly. Implements blueprint unified-packaging. Change-Id: Ieed8e3c777432cd046c3e0298869a9428756ab62
2012-02-28 23:27:46 -08:00
==================================
adding developer docs
2011-10-27 10:52:33 -07:00
This documentation is written by contributors, for contributors.
Fix build instructions and formatting in README - Fix manual build command - Fix formatting of command-line examples, directory names - Rename 'folder' to 'directory' for consistency - Update sphinx URL Partial-bug: #1257725 Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-07 12:59:38 -07:00
The source is maintained in the ``doc/source`` directory using
adding developer docs
2011-10-27 10:52:33 -07:00
`reStructuredText`_ and built by `Sphinx`_
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
Fix build instructions and formatting in README - Fix manual build command - Fix formatting of command-line examples, directory names - Rename 'folder' to 'directory' for consistency - Update sphinx URL Partial-bug: #1257725 Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-07 12:59:38 -07:00
.. _Sphinx: http://sphinx-doc.org/
adding developer docs
2011-10-27 10:52:33 -07:00
* Building Automatically::
adding version to project, setting up autobuild of docs with ./run_tests.sh --docs
2011-10-27 13:20:27 -07:00
$ ./run_tests.sh --docs
adding developer docs
2011-10-27 10:52:33 -07:00
* Building Manually::
Fix build instructions and formatting in README - Fix manual build command - Fix formatting of command-line examples, directory names - Rename 'folder' to 'directory' for consistency - Update sphinx URL Partial-bug: #1257725 Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-07 12:59:38 -07:00
$ tools/with_venv.sh sphinx-build doc/source doc/build/html
adding developer docs
2011-10-27 10:52:33 -07:00
Fix build instructions and formatting in README - Fix manual build command - Fix formatting of command-line examples, directory names - Rename 'folder' to 'directory' for consistency - Update sphinx URL Partial-bug: #1257725 Change-Id: I078bc5b9c931d4bf4e57c8fe7b335db99cc92c29
2014-05-07 12:59:38 -07:00
Results are in the ``doc/build/html`` directory
Copy Permalink