From 864c4985286cf4b947d30c6b549a45b30f455ff1 Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Fri, 11 Aug 2017 11:31:13 +0200 Subject: [PATCH] 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 --- MISSION.rst | 2 +- README.rst | 14 +++++--------- doc/source/index.rst | 3 ++- 3 files changed, 8 insertions(+), 11 deletions(-) diff --git a/MISSION.rst b/MISSION.rst index 378b12991..fb7467b24 100644 --- a/MISSION.rst +++ b/MISSION.rst @@ -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 diff --git a/README.rst b/README.rst index ec9218eb1..16a408123 100644 --- a/README.rst +++ b/README.rst @@ -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 `. +`OpenStack documentation site `_. diff --git a/doc/source/index.rst b/doc/source/index.rst index c80710490..7257aa9c9 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,7 +5,8 @@ Welcome to bifrost's documentation! .. include:: ../../MISSION.rst -Contents: +Contents +-------- .. toctree:: :maxdepth: 1