From bbcf22cc1298dd0ad4f0826c9e1186298c64569e Mon Sep 17 00:00:00 2001
From: Steven Dake <stdake@cisco.com>
Date: Thu, 20 Aug 2015 23:00:55 -0700
Subject: [PATCH] Prepare for MD to RST conversion
Sphinx and OpenStack documentation standards require the use of
RST formatted documentation. In order to get out docs integrated
into docs.openstack.org, the following steps must be taken:
1. we need to first convert the documentation to RST
2. sphinx support must be added to the repository
3. project-config must be updated with a publish-docs job
The ability to pubish to docs.openstack.org is a privilege only
available to Big Tent projects. As a result, we should be taking
advantage of this to help spread the word on our implementation.
Note the documentation was converted with a tool called pandoc
the syntax of which was:
pandoc -f markdown -t rst file.md > z
mv z file.rst
In order for git to preserve history the files have to be git mv'ed
in one commit followed by the pandoc operation in a separate commit.
Change-Id: Iba2a70b989e8305da03e8204a9b130d457b00cf0
---
README.md => README.rst | 0
compose/{README.md => README.rst} | 0
demos/heat/{README.md => README.rst} | 0
demos/magnum/redis-kube/{README.md => README.rst} | 0
devenv/{README.md => README.rst} | 0
docs/{ansible-deployment.md => ansible-deployment.rst} | 0
docs/{dev-quickstart.md => dev-quickstart.rst} | 0
docs/{image-building.md => image-building.rst} | 0
docs/{vagrant.md => vagrant.rst} | 0
9 files changed, 0 insertions(+), 0 deletions(-)
rename README.md => README.rst (100%)
rename compose/{README.md => README.rst} (100%)
rename demos/heat/{README.md => README.rst} (100%)
rename demos/magnum/redis-kube/{README.md => README.rst} (100%)
rename devenv/{README.md => README.rst} (100%)
rename docs/{ansible-deployment.md => ansible-deployment.rst} (100%)
rename docs/{dev-quickstart.md => dev-quickstart.rst} (100%)
rename docs/{image-building.md => image-building.rst} (100%)
rename docs/{vagrant.md => vagrant.rst} (100%)
diff --git a/README.md b/README.rst
similarity index 100%
rename from README.md
rename to README.rst
diff --git a/compose/README.md b/compose/README.rst
similarity index 100%
rename from compose/README.md
rename to compose/README.rst
diff --git a/demos/heat/README.md b/demos/heat/README.rst
similarity index 100%
rename from demos/heat/README.md
rename to demos/heat/README.rst
diff --git a/demos/magnum/redis-kube/README.md b/demos/magnum/redis-kube/README.rst
similarity index 100%
rename from demos/magnum/redis-kube/README.md
rename to demos/magnum/redis-kube/README.rst
diff --git a/devenv/README.md b/devenv/README.rst
similarity index 100%
rename from devenv/README.md
rename to devenv/README.rst
diff --git a/docs/ansible-deployment.md b/docs/ansible-deployment.rst
similarity index 100%
rename from docs/ansible-deployment.md
rename to docs/ansible-deployment.rst
diff --git a/docs/dev-quickstart.md b/docs/dev-quickstart.rst
similarity index 100%
rename from docs/dev-quickstart.md
rename to docs/dev-quickstart.rst
diff --git a/docs/image-building.md b/docs/image-building.rst
similarity index 100%
rename from docs/image-building.md
rename to docs/image-building.rst
diff --git a/docs/vagrant.md b/docs/vagrant.rst
similarity index 100%
rename from docs/vagrant.md
rename to docs/vagrant.rst