Fix rendering in README

It is included into doc/source/index, so its heading levels have to be
compatible with ones there. The same goes for MISSION.

Also fixes incorrect link syntax.

Change-Id: I71f575b72abad0c5992be841ac3ee5ea1094537d
This commit is contained in:
Dmitry Tantsur 2017-08-11 11:31:13 +02:00
parent bc0a12dfff
commit 864c498528
3 changed files with 8 additions and 11 deletions

View File

@ -1,5 +1,5 @@
Bifrost's Mission
=================
~~~~~~~~~~~~~~~~~
The mission of bifrost is to provide an easy path to deploy ironic in
a stand-alone fashion, in order to help facilitate the deployment of

View File

@ -1,22 +1,18 @@
#######
Bifrost
#######
-------
Bifrost (pronounced bye-frost) is a set of Ansible playbooks that
automates the task of deploying a base image onto a set of known hardware using
ironic. It provides modular utility for one-off operating system deployment
with as few operational requirements as reasonably possible.
Team and repository tags
========================
Team and repository tags:
.. image:: http://governance.openstack.org/badges/bifrost.svg
:target: http://governance.openstack.org/reference/tags/index.html
.. Change things from this point on
Use Cases
=========
~~~~~~~~~
* Installation of ironic in standalone/noauth mode without other OpenStack
components.
@ -25,8 +21,8 @@ Use Cases
* Testing and development of ironic in a standalone use case.
Documentation
=============
~~~~~~~~~~~~~
Bifrost's documentation can be found at the
`OpenStack documentation site <https://docs.openstack.org/bifrost/latest>`.
`OpenStack documentation site <https://docs.openstack.org/bifrost/latest>`_.

View File

@ -5,7 +5,8 @@ Welcome to bifrost's documentation!
.. include:: ../../MISSION.rst
Contents:
Contents
--------
.. toctree::
:maxdepth: 1