summaryrefslogtreecommitdiff
path: root/docsite/README.md
diff options
context:
space:
mode:
authorMichael DeHaan <michael.dehaan@gmail.com>2012-10-08 07:44:38 -0400
committerMichael DeHaan <michael.dehaan@gmail.com>2012-10-08 07:44:38 -0400
commitd6e4b1bf5b5d573c4f0161aec6d2235670fe41c2 (patch)
tree1bc317fc2564497b4738ea3054d1eef7f177b56e /docsite/README.md
parentc8854a23ea97d892d87a40955307cb27bbc9d408 (diff)
parentbb0b2305e3ba6df2b7400f3ca6d20c5e3b69c360 (diff)
downloadansible-d6e4b1bf5b5d573c4f0161aec6d2235670fe41c2.tar.gz
Subtree merge of ansible-docs
Diffstat (limited to 'docsite/README.md')
-rw-r--r--docsite/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docsite/README.md b/docsite/README.md
new file mode 100644
index 0000000000..73b569c138
--- /dev/null
+++ b/docsite/README.md
@@ -0,0 +1,23 @@
+Homepage and documentation source for the Ansible
+=================================================
+
+This project hosts the source behind [ansible.cc/docs](http://ansible.cc/docs)
+
+Contributions to the documentation are welcome. To make changes, submit a pull request
+that changes the restructured text files in the "rst/" directory only, and Michael can
+do a docs build and push the static files.
+
+If you do not want to learn RST format (ReStructured Text), you can also file issues
+on the documentation project.
+
+Note that module documentation can actually be generated from a DOCUMENTATION docstring
+in the modules directory, so corrections to modules written as much need to be made
+in the main project in the module source, rather than in the documentation for the module.
+
+Author
+======
+
+Michael DeHaan -- michael.dehaan@gmail.com
+
+[http://michaeldehaan.net](http://michaeldehaan.net/)
+