Unnamed repository; edit this file 'description' to name the repository. https://git.platform-os.org/openstack/kolla.git/atom?h=master 2015-09-03T05:37:36+00:00 2015-09-03T05:37:36+00:00 Steven Dake stdake@cisco.com 2015-09-03T05:33:01+00:00 urn:sha1:233864ff32af10a2c927cdbca3475b537c8e6808 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-08-21T09:10:31+00:00 Steven Dake stdake@cisco.com 2015-08-21T06:06:10+00:00 urn:sha1:6e3127d0432a25124b3068e03d6e05fac8a73e63 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-21T09:10:31+00:00 Steven Dake stdake@cisco.com 2015-08-21T06:00:55+00:00 urn:sha1:bbcf22cc1298dd0ad4f0826c9e1186298c64569e 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