diff options
| author | Steven Dake <stdake@cisco.com> | 2015-08-20 23:00:55 -0700 |
|---|---|---|
| committer | Steven Dake <stdake@cisco.com> | 2015-08-21 02:10:31 -0700 |
| commit | bbcf22cc1298dd0ad4f0826c9e1186298c64569e (patch) | |
| tree | 6131834f0daf42c2ded83809859e9b9bc424aa7f | |
| parent | 129f1d06a141c75643336399181ea157fb0dd82a (diff) | |
| download | kolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.tar.gz kolla-bbcf22cc1298dd0ad4f0826c9e1186298c64569e.zip | |
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
| -rw-r--r-- | README.rst (renamed from README.md) | 0 | ||||
| -rw-r--r-- | compose/README.rst (renamed from compose/README.md) | 0 | ||||
| -rw-r--r-- | demos/heat/README.rst (renamed from demos/heat/README.md) | 0 | ||||
| -rw-r--r-- | demos/magnum/redis-kube/README.rst (renamed from demos/magnum/redis-kube/README.md) | 0 | ||||
| -rw-r--r-- | devenv/README.rst (renamed from devenv/README.md) | 0 | ||||
| -rw-r--r-- | docs/ansible-deployment.rst (renamed from docs/ansible-deployment.md) | 0 | ||||
| -rw-r--r-- | docs/dev-quickstart.rst (renamed from docs/dev-quickstart.md) | 0 | ||||
| -rw-r--r-- | docs/image-building.rst (renamed from docs/image-building.md) | 0 | ||||
| -rw-r--r-- | docs/vagrant.rst (renamed from docs/vagrant.md) | 0 |
9 files changed, 0 insertions, 0 deletions
diff --git a/compose/README.md b/compose/README.rst index 6300ff5b9..6300ff5b9 100644 --- a/compose/README.md +++ b/compose/README.rst diff --git a/demos/heat/README.md b/demos/heat/README.rst index 78236ac1f..78236ac1f 100644 --- a/demos/heat/README.md +++ b/demos/heat/README.rst diff --git a/demos/magnum/redis-kube/README.md b/demos/magnum/redis-kube/README.rst index 73e2dc50b..73e2dc50b 100644 --- a/demos/magnum/redis-kube/README.md +++ b/demos/magnum/redis-kube/README.rst diff --git a/devenv/README.md b/devenv/README.rst index 53f0a3417..53f0a3417 100644 --- a/devenv/README.md +++ b/devenv/README.rst diff --git a/docs/ansible-deployment.md b/docs/ansible-deployment.rst index 9f277c2ab..9f277c2ab 100644 --- a/docs/ansible-deployment.md +++ b/docs/ansible-deployment.rst diff --git a/docs/dev-quickstart.md b/docs/dev-quickstart.rst index 2b79097e4..2b79097e4 100644 --- a/docs/dev-quickstart.md +++ b/docs/dev-quickstart.rst diff --git a/docs/image-building.md b/docs/image-building.rst index a67f3da08..a67f3da08 100644 --- a/docs/image-building.md +++ b/docs/image-building.rst diff --git a/docs/vagrant.md b/docs/vagrant.rst index b6f47f179..b6f47f179 100644 --- a/docs/vagrant.md +++ b/docs/vagrant.rst |