deb-manila/doc/source/index.rst
Thomas Bechtold ef6de3f584 Add Glossary with basic Manila terms
Glossary should be used to describe common terms used in Manila's
documentation. Starting using it for "manila-share", "manila-api" and
"manila-scheduler".

Change-Id: I288332f5b599c9c78d45f0102e4d2a20753af3a6
2015-04-09 14:23:54 +02:00

80 lines
2.2 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 Manila's developer documentation!
============================================
Manila is an OpenStack project to provide "Shared Filesystems as a service".
* **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**: Manila 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 Manila 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
Admin Docs
==========
.. toctree::
:maxdepth: 1
adminref/index
API Extensions
==============
Go to http://api.openstack.org for information about Manila API extensions.
Information
===========
.. toctree::
:maxdepth: 1
glossary
Outstanding Documentation Tasks
===============================
.. todolist::
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`