7 Commits

Author SHA1 Message Date
Steven Dake
233864ff32 Rename docs dir to doc for publishing
The publishing docs expect the documentation to be present in the
/doc directory not the /docs directory.  If the documentation is in
the /docs directory, according to fungi the docs won't be published
properly.

Change-Id: I718fec7e69d298a5cb2376ca4e2455e12169566e
Partially-Implements: blueprint kola-tox-doc
2015-09-02 22:37:36 -07:00
Sam Yaple
cbd42ca6e9 Move docker_templates to docker dir
Updated build.py to reflect this change.
Deprecate --template option and make it a noop.

Change-Id: I7cd98d1ee684a4c64984a49597159868152683b2
Partially-Implements: blueprint remove-docker-dir
2015-08-28 13:33:50 +00:00
Steven Dake
f895ee07cc Remove docker directory
Remove the docker directory (yay) and old build tools.

This will result in an f21 failing gate - however, I have a patch
submission to remove that gate from our project configuration.

Change-Id: I3c461cedb6906422c8076f60c470e773d6cdcf33
Partially-Implements: blueprint remove-docker-dir
2015-08-28 00:50:30 -07:00
venkatamahesh
11d78626b5 Extension .md is changed to .rst
For two links extension is wrong, it is changed
For other one the path is wrong, it is updated

Change-Id: Idc2c7054f5bd0c47ff30de79585cf902082da448
Closes-Bug: #1488025
2015-08-24 22:14:22 +05:30
xiabing.yao
946f73a11d Update Getting Started link url in README.rst
Change-Id: I89c41c9aeb4afcd4e2130b3a17194cfa9a8b6c4f
Closes-Bug: #1487871
2015-08-19 21:30:04 +08:00
Steven Dake
6e3127d043 Run pandoc to convert the documentation
This converts all MD formatted docs that were renamed to RST to
preserve git history into actual RST documentation.  Some minor
edits were made but in general the purpose of this patch is to
*only* convert the documentation not rework the documentation.
I do plan on reworking the documentation in further patch sets.

All links were tested and a test rendering is available:

    http://github.com/sdake/kolla

Change-Id: I3df430b14df1ede15407c7f4ba7afcbdc6f9d757
2015-08-21 02:10:31 -07:00
Steven Dake
bbcf22cc12 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
2015-08-21 02:10:31 -07:00