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
Tim Gerla
8a9cded133
re-add docs css class required for some theme elements
2013-06-10 07:57:13 -07: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
Tim Gerla
b3e0071635
show entire doc index in left sidebar on the documentation home page
2013-06-09 11:04:16 -07:00
Michael DeHaan
92dce671bb
Resolve merge commit
2013-06-09 13:57:20 -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
Serge van Ginderachter
0224dc464d
roles/x/scripts support: update docs
...
also added example on where regular tasks fit in
2013-05-24 22:42:24 +02:00
lwade
07a1b2f1c1
Start of aws best practices docs
2013-05-24 16:59:24 +01:00
Michael DeHaan
8475a92dec
Merge pull request #2939 from mmoya/lookup-crypted-passwds
...
Add support for crypted passwords to password lookup
2013-05-18 13:17:41 -07:00
Maykel Moya
96afc3f462
Add support for crypted passwords to password lookup
...
Added new parameter 'encrypt' with same semantics from that of
vars_prompt. When encryption is requested a random salt will be
generated and stored along the password in the form:
'<password> salt=<salt>'.
Also store passwords with an ending '\n' for easier looking at files
with console tools. File content was being already rstripped so this
is harmless.
2013-05-16 13:24:54 +02:00
Stoned Elipot
2b58e03571
Fix registered variable usage example
2013-05-15 22:11:07 +02:00
Michael DeHaan
8a860779fd
Add some notes about 1.2 things, just to make it more obvious.
2013-05-11 16:40:09 -04:00
Michael DeHaan
0748e86f0e
Fix documentation about examples in modules so folks use the new style.
2013-05-11 16:32:22 -04:00
Maykel Moya
db618f837f
Fix link to Ansible Resources in moduledev page
2013-05-07 13:01:53 +02:00
Michael DeHaan
1b5dd3f15b
Clean up variable examples to say "$x" is still fine for a reference.
2013-05-05 13:21:47 -04:00
Michael DeHaan
63b4eea90b
Remove searchindex.js from source control.
2013-05-05 12:51:27 -04:00
Michael DeHaan
d1a59fe62b
Merge branch 'when_docs' of git://github.com/tartansandal/ansible into devel
...
Conflicts:
docsite/latest/rst/playbooks2.rst
docsite/latest/searchindex.js
2013-05-05 12:43:06 -04:00
Kahlil (Kal) Hodgson
cabd40b0aa
add docs for 'when: var is defined' idiom
2013-05-03 08:57:31 +10:00
Lorin Hochstein
c66b724817
Document: sudo works per-task too
...
Document that you can use sudo at the task level as well
2013-05-02 15:14:53 -04:00
Michael DeHaan
ce67588dcf
Fix module doc organization
2013-05-02 11:35:24 -04:00
Michael DeHaan
627b6a0455
Have 1.2 clear in docs
2013-05-02 11:31:51 -04:00
Tim Gerla
bdf50d1fb7
Fix up a couple of references to 'only_if' and change them to 'when'
2013-05-02 09:22:08 -04:00
Michael DeHaan
4ce6eca8b3
Slight tweak to set_fact variable documentation to clarify scope info.
2013-04-29 19:15:29 -04:00
Michael DeHaan
4bea9a612f
Don't use "finally" here as it's not 2.4 compliant.
2013-04-28 16:03:03 -04:00
Michael DeHaan
391fb98ee2
Allow modules to be categorized, and also sort them when generating the documentation.
2013-04-28 15:03:45 -04:00
Michael DeHaan
0fd3af8c3c
Document regex patterns.
2013-04-27 12:04:22 -04:00
Michael DeHaan
099e7b39a9
use lookup macro rather than with to demonstrate lookup plugins
2013-04-27 11:59:33 -04:00
Michael DeHaan
a61824470d
Update gitignore
2013-04-27 11:55:31 -04:00
Michael DeHaan
b6a8d402c5
Document variables are reserved.
2013-04-27 11:54:30 -04:00
Lars Vogdt
21d9789377
added informations for openSUSE and SUSE Linux Enterprise
2013-04-26 11:08:13 +02:00
Michael DeHaan
13e90c396c
Merge pull request #2733 from chadoh/patch-1
...
Documentation: Mention vars_files before the Roles section in playbooks1 chapter
2013-04-22 21:21:30 -07:00
Stoned Elipot
e1ee257619
Default sudo password to SSH password.
...
While here factor out password prompting in ansible.utils
2013-04-22 23:57:50 -04:00
Michael DeHaan
b1d40ed064
Merge pull request #2734 from chadoh/patch-2
...
Documentation: Links are the best kinds of instructions
2013-04-21 14:13:06 -07:00
Jim Kleckner
5e5235a433
Nit fix spelling of separate
2013-04-21 12:33:51 -07:00
Chad Ostrowski
e1396f853b
Links are the best kinds of instructions
...
Link people right to this page on Github, so they can click "edit" right there. No need for them to search for the repo, figure out that the docsite isn't a separate repo, and navigate to the given dir.
2013-04-21 13:58:06 -03:00
Chad Ostrowski
0bb145af40
Mention vars_files before the Roles section
...
The Roles section assumes some familiarity with vars_files, which this note attempts to briefly provide.
2013-04-21 13:45:45 -03:00
Michael DeHaan
7fabaec55f
Fix doc formatting error
2013-04-20 22:48:20 -04:00
Michael DeHaan
c9a128a5c5
Rewrote the precedence docs.
2013-04-20 22:44:40 -04:00
Michael DeHaan
cf3c77661b
Document the new handler flushing system.
2013-04-20 18:10:01 -04:00
Michael DeHaan
84781bf185
Add documentation about pre_tasks and post_tasks with roles.
2013-04-20 16:21:52 -04:00
Michael DeHaan
adac8f5312
Showcase the new-style lookup plugin access in the authorized_key docs rather than the old-style $FILE
2013-04-20 09:10:19 -04:00
Michael DeHaan
cce2cad8dc
Fix with_sequence doc error
2013-04-16 20:42:06 -04:00
Michael DeHaan
84fb92dac6
Working on the FAQ.
2013-04-14 19:32:06 -04:00
Michael DeHaan
728d81bf12
Add link to prior docs version.
2013-04-12 21:48:00 -04:00
Michael DeHaan
62fe4cc3af
Explain conditionals as applied to roles. I could also explain with_items but the scope questions are complex
...
here, and it is better to include such loops inside the imported tasks.
2013-04-12 20:46:12 -04:00
Michael DeHaan
687a68091f
Mention roles in best practices
2013-04-12 18:26:17 -04:00
Michael DeHaan
ffb00d2071
Favor {{ foo }} rather than $foo in documentation.
2013-04-12 18:21:09 -04:00
Michael DeHaan
9ed246e432
Resolve merge conflict.
2013-04-12 17:51:55 -04:00
Michael DeHaan
26819d707d
Reorganize docs structure to support snapshots.
2013-04-12 17:50:50 -04:00
Michael DeHaan
e63dac15eb
Moving some more files into snapshot directory
2013-04-12 17:47:04 -04:00
Michael DeHaan
148d8859ba
Docs on parameterized roles, make document generation output less noisy
2013-04-12 17:45:27 -04:00
