placement/doc/source/index.rst
Davanum Srinivas 34ac961cc3 docs - Set pbr 'warnerrors' option for doc build
By setting this pbr option in setup.cfg, the doc build will fail in case
of any warnings or errors occur during the build process.

Closes-Bug: #1351350

Change-Id: Id4858062d2aaa4c2fe5b597e40e4e8947f544a4d
2014-08-11 12:53:37 +00:00

65 lines
2.3 KiB
ReStructuredText

..
Copyright 2010-2012 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Welcome to Nova's developer documentation!
==========================================
Nova is the project name for OpenStack Compute, a cloud computing fabric
controller, the main part of an IaaS system.
Individuals and organizations can use Nova to host and manage their own cloud
computing systems. Nova originated as a project out of NASA Ames Research Laboratory.
Nova is written with the following design guidelines in mind:
* **Component based architecture**: Quickly add new behaviors
* **Highly available**: Scale to very serious workloads
* **Fault-Tolerant**: Isolated processes avoid cascading failures
* **Recoverable**: Failures should be easy to diagnose, debug, and rectify
* **Open Standards**: Be a reference implementation for a community-driven api
* **API Compatibility**: Nova strives to provide API-compatible with popular systems like Amazon EC2
This documentation is generated by the Sphinx toolkit and lives in the source
tree. Additional draft and project documentation on Nova and other components of OpenStack can
be found on the `OpenStack wiki`_. Cloud administrators, refer to `docs.openstack.org`_.
.. _`OpenStack wiki`: http://wiki.openstack.org
.. _`docs.openstack.org`: http://docs.openstack.org
Developer Docs
==============
.. toctree::
:maxdepth: 1
devref/index
man/index
api/autoindex
API Extensions
==============
Go to http://api.openstack.org for information about Compute API extensions.
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`