Documentation updates: with_* and filter plugins

Archives Ansible Project
1

A quick update -- I've updated what I believe to be the remainder of
things we need to cover for 1.0 documentation. Much of the changes
were in the module documentation, and thanks to JPMens's fantastic
automatic-documentation-generator, it's totally self maintaining.
Neat stuff!

It turns out we were pretty good about updating things along the way
and there wasn't much to update.

The main thing was that we missed on some documentation on the (very
powerful) "lookup plugins"
features in 0.9, so I backfilled that section with a lot of new info.

http://ansible.cc/docs/playbooks2.html#lookup-plugins-accessing-outside-data

If you see other features missing in the docs, or thing anything could
be more clear, please do let me know.

You can patch the documentation by editing the "docsite/rst/*.rst"
files in the git checkout, and everything is in "Restructured Text"
format. We build our documenation with Sphinx, but you only need to
submit the RST files not the HTML as I do the builds/pushes on my end
every so often.

--Michael

2

Wow. Nice. I had a quick look, it looks like you guys added and fixed everything that has been confusing me for the past few weeks.

One thing I have been thinking about is adding a faq to add miscellaneous tidbits that don't seem to fit anywhere else in the doc, like "ansible xxxx -m setup" to check default variables, the workaround for using variables as conditional when tasks are skipped, etc...

3

We totally need a technical FAQ page.

Want to have a go at starting one?

I a bit blind to what some of the confusing parts are by now.

Even if you did not want to submit it as RST, just a bulleted list of
starting points would get us going.

--Michael

4

were in the module documentation, and thanks to JPMens's fantastic
automatic-documentation-generator, it's totally self maintaining.
Neat stuff!

/me blushes. But thank you. :slight_smile:

        -JP