Commit graph

188 commits

Author SHA1 Message Date
Michael DeHaan
82d6323845 Update docs on action shorthand. 2013-08-01 20:28:37 -04:00
Alan Descoins
d505474832 Updated documentation. 2013-07-23 19:49:27 -03:00
Joshua Lund
be6feee058 Minor cleanup of YAML Syntax documentation 2013-07-22 16:09:18 -06:00
Ches Martin
b35fc42d36 Enhance meta-docs on... contributing to docs.
- Update FAQ entry to refer to docsite README and reduce redundancy.

- Add additional info to docsite README: Sphinx building, link to module
  documentation reference.
2013-07-22 17:20:38 +07:00
Tim Gerla
7e07bca6bf very minor fix to playbooks2 to fix a formatting error 2013-07-21 11:50:12 -07:00
Michael DeHaan
77a4dcca85 Sphinx/docs syntax fixes 2013-07-21 11:18:07 -04:00
Michael DeHaan
feb4a8847d Slight edit to when_changed docs 2013-07-21 10:48:22 -04:00
Michael DeHaan
b603bb0f73 Merge branch 'changed_when-doc' of git://github.com/stoned/ansible into devel 2013-07-21 10:41:35 -04:00
Xiao Hanyu
23ff2f2992 Merging docs 2013-07-20 12:44:37 -04:00
Joshua Lund
e8c6da6045 Cleanup Glossary documentation 2013-07-19 17:32:00 -06:00
Michael DeHaan
9314341923 Merge pull request #3465 from jlund/best-practices
Add documentation for Role Variables to the Best Practices page
2013-07-19 07:33:39 -07:00
Michael DeHaan
ce89382473 Legacy variable removal. 2013-07-19 10:27:37 -04:00
Michael DeHaan
597e5075f1 Merge pull request #3585 from devo-ps/documentation
Minor typo on site about host_key_checking config section.
2013-07-19 06:50:28 -07:00
Michael DeHaan
1867fb4888 Update an example. 2013-07-19 09:49:44 -04:00
Michael DeHaan
10bc6f6d9c Merge pull request #3541 from pol/docs_withitems_regivar
Create with_items example with a registered var
2013-07-19 06:46:31 -07:00
Michael DeHaan
c101d4b30b Documentation indentation fix. 2013-07-19 09:33:31 -04:00
Michael DeHaan
deda5c8ee7 Remove backlinks:top which is setting hyperlinks in docs sections so they are hard to bookmark. 2013-07-19 09:33:31 -04:00
Michael DeHaan
ad5ac71219 Merge pull request #3542 from pol/docs_task_format
Update to conventional task format
2013-07-19 06:26:42 -07:00
Michael DeHaan
f938bc660f Slight documentation tweak. 2013-07-19 09:13:30 -04:00
Michael DeHaan
21e06a87ce Merge pull request #3530 from candeira/with_nested
add documentation for with_nested
2013-07-19 06:11:37 -07:00
Vincent Viallet
6a00cb7b3b Minor typo on site about host_key_checking config section. 2013-07-19 13:26:30 +08:00
Joshua Lund
a5459e8a03 * Added documentation for Role Variables
* Fixed a few minor typos
2013-07-16 14:53:20 -06:00
Pol Llovet
8a0861f804 Create with_items example with a registered var 2013-07-15 17:44:50 -06:00
Pol Llovet
d933fef93f Deprecate only_if in favor of when. 2013-07-15 17:41:09 -06:00
Pol Llovet
bd7448ccf0 Update to conventional task format 2013-07-15 17:35:20 -06:00
Javier Candeira
d3a97bfb07 add documentation for with_nested 2013-07-15 14:28:02 +10:00
Stoned Elipot
60d2ad3642 Document changed_when clause 2013-07-14 21:43:10 +02:00
Michael DeHaan
324a28f3dd Merge pull request #3439 from eest/bestpractices_templates_fix
Fix path to ntp.conf.j2 in example.
2013-07-11 05:31:25 -07:00
Michael DeHaan
90dfc115d6 Merge pull request #3463 from stoned/filterskipped
Add Jinja2 filter 'skipped' to test for a registered variable from a ski...
2013-07-11 05:26:25 -07:00
Joshua Lund
7c78fef1f5 Fixed some minor typos in the Advanced Playbooks documentation 2013-07-10 13:09:12 -06:00
Stoned Elipot
906746b1f0 Add Jinja2 filter 'skipped' to test for a registered variable from a skipped task 2013-07-07 22:13:14 +02:00
Michael DeHaan
d002c2d907 Document 'smart' option and connection type default changes. 2013-07-04 19:10:56 -04:00
Michael DeHaan
107ced7ec5 Mention envrionment variable configuration. 2013-07-04 18:56:46 -04:00
Michael DeHaan
1ead97098d Talk more about transports in documentation. 2013-07-04 18:51:47 -04:00
Patrik Lundin
1f1aa1f0a8 Fix path to ntp.conf.j2 in example.
The "common" role adds "common/templates/" to the src path.
2013-07-04 15:42:46 +02:00
Michael DeHaan
f3dc5707a8 Merge pull request #3282 from jlaska/devel
Reference ansible_lsb.major_release, not ansible_lsb.major_version
2013-06-30 16:43:30 -07:00
Michael DeHaan
39105dc853 Fix RST formatting in documentation (underline too short) 2013-06-30 19:01:06 -04:00
Michael DeHaan
6dd93fa964 Some minor doc tweaks 2013-06-30 18:32:49 -04:00
Michael DeHaan
ee4d9b1516 Merge branch 'devel' of git://github.com/shirou/ansible into devel 2013-06-30 18:28:35 -04:00
Michael DeHaan
f2e3a9a850 Merge pull request #3370 from y-p/PR_role_doc_enh
Add doc example of attaching tags to a role
2013-06-30 14:18:11 -07:00
y-p
a4dfc14a6c Add doc example of attaching tags to a role 2013-06-28 16:28:41 +03:00
shirou
a439afeb8f add description about host parameters in a inventory file. 2013-06-28 17:59:47 +09:00
James Laska
eb2ae8b3c2 Reference major_release, not major_version 2013-06-20 08:23:49 -04:00
Michael DeHaan
85ef79443a Fix a documentation formatting warning. 2013-06-19 22:38:04 -04:00
Joshua Lund
0f81d1630f * Updated all ansible.cc references in the documentation to point
to ansibleworks.com
* Fixed a few misspelled words
2013-06-19 19:34:02 -06:00
Michael DeHaan
58f5bfb4c1 Merge pull request #3252 from tgerla/gettingstarted
Explicitly mention the Linux requirement for the Ansible machine, remove...
2013-06-19 17:08:11 -07:00
Tim Gerla
f2cf8d3e67 Fine-tune Ansible control system OS requirements a bit 2013-06-18 18:19:58 -07:00
Jim Tittsler
240a52906e spelling ansbile->ansible 2013-06-19 10:37:02 +12:00
Tim Gerla
6f426f7986 Explicitly mention the Linux requirement for the Ansible machine, and remove a vestigial heading. 2013-06-18 12:12:37 -07:00
Michael DeHaan
89ee762ab7 Merge pull request #3247 from SirScott/vars_prompt_docs
Document the 'default' argument for vars_prompt.
2013-06-18 11:48:49 -07:00
Joshua Lund
ba853b8c1a Fixed a few small typos 2013-06-18 12:26:40 -06:00
Scott Sturdivant
cc12b85e49 Document the 'default' argument for vars_prompt. 2013-06-18 09:25:51 -06:00
Michael DeHaan
fda74110bd Merge pull request #3202 from trbs/20130613_docs_fix_ansible_cfg_loading_order
docs fix ansible cfg loading order
2013-06-16 20:17:25 -07:00
Michael DeHaan
306caf84f9 Merge pull request #3218 from lorin/fileglob-roles
Document: with_file(glob) relative path and roles
2013-06-16 19:52:22 -07:00
Michael DeHaan
a1d1ce8360 Merge branch 'docs_examples' of git://github.com/jpmens/ansible into standardize_docs 2013-06-16 22:07:20 -04:00
Jan-Piet Mens
5c69918d53 DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string
  Added deprecation warning to moduledev.rst and remove deprecated example from it
  Fixed up a few typos and uppercased some acronyms.
  add consistency to how EXAMPLES are formatted
2013-06-15 20:54:25 +02:00
Lorin Hochstein
d7ba2e06eb Document: with_file(glob) relative path and roles
Document that with_file and with_fileglob path is relative to
the files directory inside of a role.
2013-06-14 11:15:45 -04:00
trbs
653fac2f5c fix loading order of ansible.cfg in documentation 2013-06-13 23:13:54 +02:00
Ralph Bean
dd5707ddd9 Well, a little more readability. 2013-06-11 14:58:28 -04:00
Ralph Bean
416e72c900 Fix a typo in the docs. 2013-06-11 14:54:42 -04:00
Michael DeHaan
643b5e2c5d Fix dead link, remove redundant section. 2013-06-10 18:37:56 -04:00
Michael DeHaan
1fd863cf5d Update docs to reference release tarball directory on new site. 2013-06-10 16:06:58 -04:00
Michael DeHaan
36e9cf5d7d Mention YAML variable quoting. 2013-06-09 21:35:51 -04:00
Michael DeHaan
36c3c91d6e Add roles to glossary. 2013-06-09 21:20:35 -04:00
Buce
7d2422cf92 Update supported package managers
Ansible has modules for package managers other than yum and apt,
so update the documentation accordingly.
2013-06-09 17:16:08 -04:00
Buce
563147d344 Reference Inventory & Patterns more
Link to the Inventory & Patterns page in places where the Getting
Started guide refer to it, so that users unfamiliar with the
inventory syntax can easily familiarize themselves with it.
2013-06-09 17:16:08 -04:00
Michael DeHaan
d706aca82b Merge 2013-06-09 13:55:58 -04:00
Michael DeHaan
2f37314d41 Revise section referencing 1.1 since release is Monday. Will push with release. 2013-06-08 14:15:10 -04:00
Michael DeHaan
cabeafc550 Remove 1.1 reference (docs will be pushed with release of 1.2) 2013-06-08 14:14:12 -04:00
Bartłomiej Piotrowski
cd65bbc1c4 Add info about apk-tools module to contrib.rst. 2013-06-06 15:00:05 +02:00
Tim Gerla
a26cbd957c fix heading styles for 'pending information' to avoid creating a new top-level chapter 2013-06-04 14:57:43 -07:00
Patrick Regan
4e5c0da7d6 Trivial typo fix in Amazon documentation 2013-06-03 13:54:26 -04:00
Serge van Ginderachter
18e7974021 add mention of github.com/ginsys/ansible-plugins in contrib.rst 2013-06-02 17:56:12 +02:00
Michael DeHaan
7f0e89a2f6 Explain when statements with |failure and |success. 2013-06-01 17:41:31 -04:00
Michael DeHaan
754d5f91a3 Show how to set PW length. 2013-06-01 12:36:24 -04:00
Michael DeHaan
bddbdd4881 avoid duplicate hyperlink warning (silly Sphinx) 2013-06-01 12:22:06 -04:00
Michael DeHaan
1de2028677 Update docs about examples, add edX online's configuration repo to examples 2013-06-01 11:46:32 -04:00
Michael DeHaan
9f567f05d6 Document group_vars and host_vars additional paths. 2013-06-01 10:40:39 -04:00
Michael DeHaan
fbba92b61e Add an example of JSON extra variables on the command line. 2013-05-31 16:07:40 -04:00
Jan Duzinkiewicz
8ebd1792eb advanced playbooks docs yaml snippets always use --- 2013-05-31 10:54:13 +02:00
Michael DeHaan
e75ab08e3d Merge pull request #3054 from maxamillion/maxamillion/docsite
provide link to older docs when mentioning older docs
2013-05-29 16:55:30 -07:00
Michael DeHaan
53c490f453 Merge pull request #3050 from lorin/os-grizzly-only
Document: OpenStack inventory script needs grizzly
2013-05-29 15:54:49 -07:00
Michael DeHaan
fd77804bff Merge pull request #3017 from sergevanginderachter/roles-script
Add roles support for the script module
2013-05-29 15:54:18 -07:00
Adam Miller
80bf5d49fe provide link to older docs when mentioning older docs 2013-05-29 17:29:59 -05:00
Michael DeHaan
0a28358ebc Minor docs tweak. 2013-05-29 18:27:16 -04:00
Michael DeHaan
c9b2df619b Merge pull request #3043 from mvo5/feature/document-facts
Feature/document facts
2013-05-29 15:23:15 -07:00
Michael DeHaan
31b31a12e7 Merge pull request #3052 from chelsea/devel
Updated loop documentation with explicit example of hash usage
2013-05-29 15:21:19 -07:00
Adam Miller
33870745b1 fix ambiguous use of automatically automatic in Roles docs 2013-05-29 17:14:20 -05:00
Chelsea Robb
b8045bc29e Updated loop documentation with explicit example of hash usage 2013-05-30 08:05:14 +10:00
Michael DeHaan
b5ed926720 Add AWS doc to table of contents. 2013-05-29 14:17:32 -04:00
Lorin Hochstein
bbe352b544 Document: OpenStack inventory script needs grizzly
The OpenStack Inventory script uses the OS-EXT-IPS:type parameter
to distinguish between fixed and floating IP addresses.
This was only added in the Grizzly release, see
https://bugs.launchpad.net/nova/+bug/1117784

Specify in the docs that this inventory script requires Grizzly
or greater.
2013-05-29 11:38:11 -04:00
Michael DeHaan
267b29cec7 Manpage tweaks, docs rebuild 2013-05-29 10:30:04 -04:00
Michael DeHaan
efee2e2630 Some tweaks to EC2 docs 2013-05-29 10:25:54 -04:00
Michael DeHaan
383b8ce14a Merge branch 'awsdocs' of git://github.com/lwade/ansible into devel 2013-05-29 10:15:02 -04:00
Michael DeHaan
2c433cb707 Add an example of Jinja2 casting. 2013-05-29 09:43:32 -04:00
Michael Vogt
746edecf68 fix indent 2013-05-28 18:32:14 +02:00
Michael Vogt
b625f99938 fix typo 2013-05-28 18:25:44 +02:00
Michael Vogt
e13842fad1 add gathering-facts example 2013-05-28 18:23:12 +02:00
Michael Vogt
03e9d9a742 update info on debian/ubuntu packages 2013-05-28 18:12:33 +02:00
Serge van Ginderachter
5859af7285 script support for roles: use the files/ directory
instead of an additional scripts/ directory
2013-05-25 16:51:59 +02:00