# How about a Wiki?

**URL:** <https://forum.ansible.com/t/how-about-a-wiki/12352>\
**Category:** Ansible Project\
**Created:** [February 14, 2013, 2:58am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352 "2013-02-14T02:58:10Z")\
**Posts on this page:** 7\
**Page:** 1

<div class="post-metadata">

**Author:** ![Fff\_Fff](https://avatars.discourse-cdn.com/v4/letter/f/5e9695/32.png) [@Fff\_Fff](https://forum.ansible.com/u/Fff_Fff)\
**Post date:** [February 14, 2013, 2:58am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/1 "2013-02-14T02:58:10Z")

</div>

Been using Ansible for a little over a week now. I’ve messed around with Chef a bit but I’m not a coder and don’t know anything about YAML so basically a beginner when it comes to this stuff.

Really starting to like Ansible. Took me less than an hour to have it installed, add a couple test nodes, and start issuing ad hoc commands. That says a lot. Within a couple days I had YAML figured out and made a simple functional playbook. Now I am learning how to split up files in to tasks/handlers/templates/variables. The template stuff is going to take me awhile longer but I already have some pretty practical playbooks so very impressed with the easy learning curve and power of it so far.

My only real complaint is the documentation. A bit lacking in places. I would like to see more examples organized by topic as well. Yes I am googling and finding lots of examples on github but you can’t really search by topic doing it that way. Seems to me this project could use a wiki that people can contribute to no?!

---

<div class="post-metadata">

**Author:** ![Michael\_DeHaan](https://avatars.discourse-cdn.com/v4/letter/m/c4cdca/32.png) [@Michael\_DeHaan](https://forum.ansible.com/u/Michael_DeHaan)\
**Post date:** [February 14, 2013, 3:18am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/2 "2013-02-14T03:18:06Z")

</div>

Everyone's docs can always be improved. While we get lots of "the  
documentation is awesome" comments, I get even more "documentation is  
way better than XYZ's Wiki" comments.  
The Wiki is not the answer.

That being said, different people learn in different ways. The best  
way for us to understand what needs to be documented better is to hear  
it, and to present those things in different ways  
so people CAN learn them differently.

There are a few things we are going to do short term

(A) add a glossary section, linking to all the keywords  
(B) rewrite the best practices section, showing how to put it all  
together, and have a nicer example playbook to point people to on  
github showing that organization

I think that will address most concerns.

I don't like Wikis as they grow unmaintained and can be edited rather  
haphazardly -- we review all of our documentation.

We also have a lot of sample playbooks in the resources section that  
I'd recommend looking over.

---

<div class="post-metadata">

**Author:** ![Michael\_DeHaan](https://avatars.discourse-cdn.com/v4/letter/m/c4cdca/32.png) [@Michael\_DeHaan](https://forum.ansible.com/u/Michael_DeHaan)\
**Post date:** [February 14, 2013, 3:41am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/3 "2013-02-14T03:41:53Z")

</div>

BTW, docs all live in git.

github.com/ansible/ansible

cd docsite/rst

We're not a Wiki, but docs \*are\* community maintained.

---

<div class="post-metadata">

**Author:** ![VK1](https://avatars.discourse-cdn.com/v4/letter/v/bbce88/32.png) [@VK1](https://forum.ansible.com/u/VK1)\
**Post date:** [February 14, 2013, 5:10am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/4 "2013-02-14T05:10:17Z")

</div>

I'll second the need for more up-to-date docs.

This list (Michael in particular 8-)) has been very responsive (thanks!), but I could've spent less time on some things.

Off the top of my head, if I may add to this thread some things that I've run into before I forget:

- Download and Documentation section @ ansible.cc should have both; missing clear download info for non-developers looking for latest release tarball.  
- RPM building  
- variables such as stdout\_lines  
- yum module - it seems you can install RPMs that are local files (i.e. not from a repo) but it's not documented under the module.

Thanks

---

<div class="post-metadata">

**Author:** ![Michael\_DeHaan](https://avatars.discourse-cdn.com/v4/letter/m/c4cdca/32.png) [@Michael\_DeHaan](https://forum.ansible.com/u/Michael_DeHaan)\
**Post date:** [February 14, 2013, 12:41pm UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/5 "2013-02-14T12:41:40Z")

</div>

Thanks for the list, will get it taken care of!

---

<div class="post-metadata">

**Author:** ![Fff\_Fff](https://avatars.discourse-cdn.com/v4/letter/f/5e9695/32.png) [@Fff\_Fff](https://forum.ansible.com/u/Fff_Fff)\
**Post date:** [February 15, 2013, 3:47am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/6 "2013-02-15T03:47:59Z")

</div>

I personally would like to see more examples. I think the really basic stuff is covered ok but I am hitting a bit of a wall after that. Specifically making calls to task/handler files. Also would like to see a LOT more examples of working with variables and templates and variables in templates. Just providing a link to the junja website doesn’t cut it for me. I have to wade through too many details on that site. Not even sure how much of that applies to ansible anyways.

---

<div class="post-metadata">

**Author:** ![Michael\_DeHaan](https://avatars.discourse-cdn.com/v4/letter/m/c4cdca/32.png) [@Michael\_DeHaan](https://forum.ansible.com/u/Michael_DeHaan)\
**Post date:** [February 15, 2013, 4:25am UTC](https://forum.ansible.com/t/how-about-a-wiki/12352/7 "2013-02-15T04:25:04Z")

</div>

Understood --

Look through [http://ansible.cc/docs/contrib.html](http://ansible.cc/docs/contrib.html) for "Selected  
Playbooks" and [https://github.com/ansible/ansible/tree/devel/examples/playbooks](https://github.com/ansible/ansible/tree/devel/examples/playbooks)  
in the meantime, and let us know what specific questions you have.
