From e142ac81c8b526db53ba0d509f13cd7c5263a9c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Natal=20Ng=C3=A9tal?= Date: Thu, 20 Dec 2018 10:15:34 +0100 Subject: [PATCH] [Documentation] Migrate the format. Moved the file to README.rst for consistency with other OpenStack project documentation. Change-Id: I5f80d6318d8119e152e1b73aad4e3ba22daf46e4 --- README.md => README.rst | 17 ++++++++++------- setup.cfg | 2 +- 2 files changed, 11 insertions(+), 8 deletions(-) rename README.md => README.rst (88%) diff --git a/README.md b/README.rst similarity index 88% rename from README.md rename to README.rst index 37234dc18..974e70321 100644 --- a/README.md +++ b/README.rst @@ -1,23 +1,26 @@ +======================== Team and repository tags ======================== -[![Team and repository tags](https://governance.openstack.org/tc/badges/tripleo-image-elements.svg)](https://governance.openstack.org/tc/reference/tags/index.html) +.. image:: https://governance.openstack.org/tc/badges/tripleo-image-elements.svg + :target: https://governance.openstack.org/tc/reference/tags/index.html - +.. Change things from this point on Image building rules for OpenStack images ========================================= These elements are used to build disk images for deploying OpenStack via Heat. -They are built as part of the TripleO (https://wiki.openstack.org/wiki/TripleO) -umbrella project. +They are built as part of the TripleO_ umbrella project. + +.. _TripleO: https://wiki.openstack.org/wiki/TripleO Instructions ------------ Checkout this source tree and also the diskimage builder, export an -ELEMENTS\_PATH to add elements from this tree, and build any disk images you -need: +ELEMENTS_PATH to add elements from this tree, and build any disk images you +need:: virtualenv . source bin/activate @@ -80,7 +83,7 @@ Copyright ========= Copyright 2012,2013 Hewlett-Packard Development Company, L.P. -Copyright (c) 2012 NTT DOCOMO, INC. +Copyright (c) 2012 NTT DOCOMO, INC. All Rights Reserved. diff --git a/setup.cfg b/setup.cfg index 3382d3ac9..f318469f0 100644 --- a/setup.cfg +++ b/setup.cfg @@ -2,7 +2,7 @@ name = tripleo-image-elements summary = Disk image builder elements for deploying OpenStack. description-file = - README.md + README.rst author = OpenStack author-email = openstack-discuss@lists.openstack.org license = Apache License (2.0)