aboutsummaryrefslogtreecommitdiff
path: root/compose/README.rst
AgeCommit message (Collapse)AuthorFilesLines
2015-10-07Remove compose from the repostiory since its dead codeSteven Dake1-8/+0
Several people over the liberty cycle committed to maintaining compose, but it was never completed. Rather than carry compose in our repoistory until the end of time in a broken state I propose removing it. If someone comes along and wants to resseruct the code and make it functional in the future, I'd be 100% open to merge a patch in the future which reintroduces this functionality. In the meantime it is confusing to users which ask me on a daily basis if compose is supported which I have to go into a 10 minute monologue about why its in the repository. Fortunately git contains full history so we can always revert this change at a later time if someone wants to actually fixt his code base up and make it useable in some way. I think the proper answer is a seperate repoistory (kolla-compose) which contains any compose related bits. Please consider removing since nobody is using this code and its dead. TrivialFix backport: liberty Change-Id: I8b7c39b00d1967184d363af7db86d1ff8b5e725f
2015-08-21Run pandoc to convert the documentationSteven Dake1-25/+4
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-21Prepare for MD to RST conversionSteven Dake1-0/+29
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