mogan/doc/source/index.rst
liusheng 10c429e08a [DOC] Add contributor guide for versioned notification
Change-Id: I79a2842bf31d6b8f6f697e4bdc980db959efa7cc
2017-09-22 09:24:57 +08:00

103 lines
2.1 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.
====================================
OpenStack Bare Metal Compute (mogan)
====================================
Introduction
============
Mogan is an OpenStack project which offers bare metals as first class
resources to users, supporting variety of bare metal provisioning drivers
including Ironic.
Contributor Guide
=================
If you are new to mogan, this section contains information that should help
you get started as a developer working on the project or contributing to the
project.
.. toctree::
:maxdepth: 1
contributor/code-contribution-guide
contributor/dev-quickstart
contributor/make-changes-to-database
contributor/testing
contributor/notifications
Installation Guide
==================
.. toctree::
:maxdepth: 1
installation/configure-mogan-api-uwsgi
installation/build-user-images
User Guide
==========
.. toctree::
:maxdepth: 1
user/states
user/availability-zones
user/root-disk-partitions
user/server-groups
Administrator Guide
===================
.. toctree::
:maxdepth: 1
admin/flavors
admin/aggregates
admin/gmr
Configuration Guide
===================
.. toctree::
:maxdepth: 1
configuration/sample_config
configuration/sample_policy
Command References
==================
Here are references for commands not elsewhere documented.
.. toctree::
:maxdepth: 1
cmds/mogan-dbsync
Indices and tables
==================
* :ref:`search`