Commit Graph

688 Commits (796ac6d01cd645842ccfaa677219a408c1a9a039)

Author SHA1 Message Date
Michael DeHaan 83d298accc Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list. 2013-12-25 21:29:54 -05:00
Michael DeHaan d6e28b4c57 Enable the very cool "Edit on GitHub" links for pages where the RST is straight
out of github.
2013-12-25 21:05:25 -05:00
Mikhail Sobolev 8b680343dd fix example formatting 2013-12-25 21:19:00 +02:00
Mikhail Sobolev af1f8db51d remove trailing whitespaces 2013-12-25 21:19:00 +02:00
Michael DeHaan de8520da21 Add analytics to new docs theme. 2013-12-25 13:38:40 -05:00
Michael DeHaan 35ec9f81ae Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections. 2013-12-25 13:24:29 -05:00
Michael DeHaan 10009b0d3f Starting to refactor module formatter script.
Rename "jpfunc" to something more explanatory
2013-12-25 13:24:29 -05:00
Michael DeHaan 080296a028 Merge pull request #5414 from jlund/mode-typo
Fixing a typo in the Amazon Web Services and Rackspace Cloud guides
2013-12-24 15:57:09 -08:00
Michael DeHaan b0578c82c2 Merge pull request #5416 from sa2ajj/more-minor-doc-fixes
More minor doc fixes
2013-12-24 15:56:50 -08:00
Michael DeHaan 99daaa5bb5 Re-add the playbook introduction which was replaced earlier. 2013-12-24 18:51:46 -05:00
Mikhail Sobolev d1d20b7065 add a link to the resources section 2013-12-25 01:20:00 +02:00
Mikhail Sobolev 34f65f8e84 fix the link formatting 2013-12-25 01:19:41 +02:00
Michael DeHaan 1a106ac419 Add copy of Sphinx RTD theme so we can modify if needed and everyone has a consistent copy. 2013-12-24 18:10:19 -05:00
Michael DeHaan e00262c1b3 Split content into subpages. 2013-12-24 18:05:41 -05:00
Michael DeHaan 5b5556020f Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 17:51:16 -05:00
Michael DeHaan 041cea134f New Sphinx theme has sidebar navigation so don't need TOC on each page. 2013-12-24 17:29:28 -05:00
Michael DeHaan be78b50ea0 Remove static theme files since we're just grabbing the theme from pip. 2013-12-24 17:24:05 -05:00
Michael DeHaan c88c3a40c6 Use the sphinx_rtd_theme 2013-12-24 17:23:38 -05:00
Joshua Lund 1696b14beb Fixing a typo in the Amazon Web Services and Rackspace Cloud guides 2013-12-24 15:11:24 -07:00
Michael DeHaan 384cac7779 Use a docsite theme that is in source control, work in progress. 2013-12-24 14:10:49 -05:00
Matt Martz c328cdbb53 Missed prefixed variable attribute 2013-12-23 13:56:48 -06:00
Tim Gerla c89381fa2e minor typo fixes for the rolling update guide 2013-12-20 16:02:36 -08:00
Michael DeHaan d6ea5be20f Various syntax and layout things, add Galaxy to docs 2013-12-20 17:07:06 -05:00
Michael DeHaan d481b6e686 Some slight tweaks to the continuous delivery docs. 2013-12-20 16:43:18 -05:00
Michael DeHaan 12e61b6c32 Merge branch 'lamp_tutorial' of git://github.com/tgerla/ansible into devel 2013-12-20 16:31:44 -05:00
Michael DeHaan 08792be98e Some minor tweaks to make things a little more tutorial-like, moved credentials section up higher, etc. 2013-12-20 16:30:55 -05:00
Michael DeHaan de24a40cde Wrap lines a bit tighter for easier editing. 2013-12-20 16:13:40 -05:00
Michael DeHaan bb165f423d Merge branch 'rax-guide' of git://github.com/sivel/ansible into devel 2013-12-20 16:07:00 -05:00
James Tanner fd96bcbb67 Update released version in the docsite index page 2013-12-20 13:28:10 -05:00
Matt Martz 1e1a943a6e Fix rst warnings in playbooks_loops.rst 2013-12-20 11:37:38 -06:00
Matt Martz 22dd1590df Add guide_rax.rst 2013-12-20 11:18:24 -06:00
Matt Martz e8ef6f14af Add documentation example of using 'register' with a loop 2013-12-19 12:11:00 -06:00
lichesser 1cbae778c4 Update install documentation to include httplib2
With v1.4.2 setup.py requires httplib2 for install
2013-12-19 12:01:58 +01:00
James Tanner 982c9394b2 Add example4 to the docsite AWS guide 2013-12-18 21:05:10 -05:00
James Tanner 78346eb358 Fix current version in docsite index.rst 2013-12-18 21:01:20 -05:00
Mikhail Sobolev 6569fb8455 fixed a reference to AWX site 2013-12-15 13:12:20 +02:00
Mikhail Sobolev 4448a64069 add seealso to developing_inventory 2013-12-15 13:09:43 +02:00
Tim Gerla f8cc9d5d06 Tweak some task examples to be more in-line with eucalyptus-ec2.yml in language_features 2013-12-12 13:44:33 -06:00
Ferenc Grecu b93c23d4c7 Fix typos in configuration documentation 2013-12-12 18:51:09 +02:00
Tim Gerla 1063cbea39 tweak some links and phrasing 2013-12-08 19:40:21 -08:00
Tim Gerla 101e8c0a31 flesh out the CI/CD and load balancer sections a bit 2013-12-08 13:19:09 -08:00
Maykel Moya 9018d53a3c Fix link to playbooks loops 2013-12-08 22:09:54 +01:00
Tim Gerla 4da5d267d5 initial commit of a basic rolling upgrade guide, based on the lamp_haproxy example 2013-12-08 12:56:57 -08:00
Michael DeHaan a19ef93cf3 Update README.md
remove author section, references old email address
2013-12-05 19:22:05 -05:00
Michael DeHaan 0fc5771eab Update README.md
Clarify docs readme about wordpress
2013-12-05 19:17:02 -05:00
Jinn Koriech 80d6ca19af Add README info for building the module documentation. 2013-12-05 17:01:49 +00:00
Maykel Moya bddb1e3115 Add blank line before rst directive 2013-12-03 11:51:44 +01:00
Michael F. Booth 8a19b595c7 Fix "manual" ansible-playbook example in guide_vagrant.rst
The given example is trying to load an inventory file with the -i option, so it should probably be given the actual Vagrant-written inventory file name. I contemplated using 'vagrant_ansible_inventory_default' instead (which is what my Vagrant demo actually creates) but 'vagrant_ansible_inventory_machinename' is more consistent with the existing example in the docs.
2013-12-01 23:25:23 -05:00
Michael DeHaan 3541bfcb09 Merge pull request #5074 from pcraston/devel
Fix for documentation playbook loops
2013-12-01 14:29:47 -08:00
Tim Gerla af42f0b771 fix heading name syntax in AWS guide 2013-11-27 12:36:49 -08:00
Patrick Craston 8de0b88c1c Updated Fix for documentation playbook loops
if key is used with lookup parameter needs quotes as
otherwise it will load "ssh-rsa" "<the key>" "<the comment>" as separate
values and fail with "this module requires key=value arguments"
2013-11-27 13:12:50 +00:00
Patrick Craston 20c5b7f800 Fix for documentation playbook loops
if key is used with lookup parameter that needs to be in quotes as
otherwise it will load "ssh-rsa" "<the key>" "<the comment>" as separate
values and fail with "this module requires key=value arguments"
2013-11-27 11:59:11 +00:00
Tim Gerla fb3d5d6589 elaborate on a couple of sections 2013-11-23 14:59:35 -08:00
Tim Gerla 461afa2b25 remove Vagrant from the list of pending topics 2013-11-23 11:13:56 -08:00
Tim Gerla 1cd71b7899 fix up word wrapping 2013-11-23 11:10:43 -08:00
Tim Gerla 7adf33ed41 add a topical guide for Vagrant integration 2013-11-23 11:07:51 -08:00
James Tanner 2a58c2bbe3 Update files for 1.4 release 2013-11-21 15:11:16 -05:00
Brian Coca 246689c2fd added version added + union, diff and sym_diff filters
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-11-19 14:37:53 -05:00
Brian Coca 79145b6a78 updated docs to add new filters
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-11-18 23:40:29 -05:00
Michael DeHaan ff24d5a16e Merge pull request #4952 from bob-smith/new3
Remove stale references to 'latest' from docsite
2013-11-18 13:19:31 -08:00
John Barker 0bc93bf0c0 Remove stale references to 'latest' from docsite
left over from 0cd09dd
2013-11-18 20:58:28 +00:00
Michael DeHaan 441cd1c5b9 Merge pull request #4933 from lsm/devel
Correct the constant name "remote_temp" to "remote_tmp"
2013-11-18 11:48:55 -08:00
John Barker 452d418771 correct link to developing modules on ansiblework's website (part 2) 2013-11-18 19:21:46 +00:00
Senmiao Liu d1082af817 Correct the constant name "remote_temp" to "remote_tmp" 2013-11-17 15:37:17 -08:00
Michael Scherer f290c2aec0 fix various typos in the documentation 2013-11-17 00:26:06 +01:00
James Tanner 48ded5e493 Fix typos in docsite password lookup section 2013-11-12 08:54:19 -05:00
James Tanner e2b75abb1d Add char parameter to password lookup plugin docs on docsite 2013-11-11 14:54:11 -05:00
James Tanner 9e8eef84e8 Revert "Revert "Delete extra word in index.rst""
This reverts commit 8532263890.
2013-11-11 13:23:27 -05:00
James Tanner 54c510335a Revert "Revert "Tiny RST link fix in modules documentation""
This reverts commit 658dc7a366.
2013-11-11 13:23:03 -05:00
James Tanner f347133d85 Revert "Move info on limit from the ad hoc command page to the pattern page"
This reverts commit cda707f99e.
2013-11-08 10:51:28 -05:00
James Tanner 658dc7a366 Revert "Tiny RST link fix in modules documentation"
This reverts commit e052251662.
2013-11-08 10:46:13 -05:00
James Tanner 8532263890 Revert "Delete extra word in index.rst"
This reverts commit f52b401755.
2013-11-08 10:45:56 -05:00
James Tanner 66d68b30f2 Revert "Fixes #4092 Add documentation for yaml format of tasks and all keywords"
This reverts commit 3e351b4727.
2013-11-08 10:31:28 -05:00
James Tanner 4169f1b07c Revert "Fixes #4771 Add 1.4.x example of registered var properties to the docsite"
This reverts commit dc74e700ce.
2013-11-08 10:30:45 -05:00
James Tanner dc74e700ce Fixes #4771 Add 1.4.x example of registered var properties to the docsite 2013-11-08 10:20:05 -05:00
James Tanner 3cdb968ebe Fix some information in the docsite for the password lookup plugin 2013-11-07 16:45:52 -05:00
Steve Tjoa 9ac012bb94 adding link to up-to-date ansible-examples github repo. Also using proper capitalization for GitHub. 2013-11-07 11:44:54 -08:00
jctanner e9ad19f593 Merge pull request #4824 from mattwillsh/devel
Correct docsite typo hash_behavior -> hash_behaviour
2013-11-06 22:48:12 -08:00
James Tanner 3e351b4727 Fixes #4092 Add documentation for yaml format of tasks and all keywords 2013-11-07 01:43:55 -05:00
James Tanner c39daed422 Merge pull request #4607 and fix merge conflicts for documentation fixes. 2013-11-06 22:20:58 -05:00
jctanner 1b89abe176 Merge pull request #4669 from SegFaultAX/docs/ssh-ansible-cfg
Change ssh header to ssh_connection header
2013-11-06 19:04:33 -08:00
Matt Willsher a7d0056a53 Correct type hash_behavior -> hash_behaviour 2013-11-06 17:01:37 +00:00
jctanner 8d9b53b445 Merge pull request #4733 from sivel/4323-sudo-pass
Add ansible_sudo_pass hostvar support. Fixes #4323
2013-11-05 15:01:19 -08:00
James Tanner a66cfed166 Addresses #4763 list python >= 2.5 as a requirement for accelerate mode 2013-11-04 18:15:11 -05:00
Tomas Thor Jonsson 23bf570bad typo ---- (4) instead of --- (3) 2013-11-04 14:16:33 +01:00
Michael DeHaan 4bb34d006e Merge pull request #4793 from ilkka/patch-2
Fix code block quoting in documentation
2013-11-03 08:55:33 -08:00
Ilkka Laukkanen 31d55e03b0 Fix code block quoting
Add double colons where necessary to get code blocks, not blockquotes.
2013-11-03 18:31:25 +02:00
Ilkka Laukkanen e0e01ddbe4 Clarify cobbler.py usage and testing instructions
The doc incorrectly advised executing the static inventory, not the `cobbler.py` script. Also fixes minor language issue.
2013-11-03 18:26:28 +02:00
Rhett Sutphin aa475d337a Document env dependency for test-module.
You need to source hacking/env-setup before running hacking/test-module;
otherwise you get an error like this:

    ImportError: No module named ansible.utils
2013-11-01 12:32:15 -05:00
Matt Martz ea2ec6237a Add ansible_sudo_pass hostvar support 2013-10-30 13:18:35 -05:00
Tim Gerla 0f80364994 fix command to make a debian package 2013-10-28 15:04:16 -07:00
Tim Gerla b7899b5e35 Add a clarifying heading to installation docs 2013-10-28 08:55:25 -07:00
Matt Jaynes 8fa003eadb Fix typos. Prevent double-dashes from being reduced to single dash. 2013-10-27 11:51:42 -04:00
Michael-Keith Bernard d1d4af8b11 Change ssh header to ssh_connection header 2013-10-24 11:24:24 -07:00
Lars Francke f52b401755 Delete extra word in index.rst 2013-10-22 01:14:24 +02:00
Lars Francke e052251662 Tiny RST link fix in modules documentation 2013-10-22 01:10:54 +02:00
Lars Francke d7478e591c Update intro_configuration.rst
Minor RST fixes
2013-10-22 01:05:40 +02:00
Lars Francke cda707f99e Move info on limit from the ad hoc command page to the pattern page 2013-10-21 11:17:25 +02:00
Lars Francke 544458e859 Update intro_adhoc.rst
Update link texts (hopefully got those correct from Sphinx documentation) and remove section on Limiting hosts as that's covered elsewhere
2013-10-21 11:17:16 +02:00
Lars Francke afbc2b448d Update intro_dynamic_inventory.rst
Minor fixes, style and typos
2013-10-21 00:17:26 +02:00
Lars Francke 5c905fd165 Fix a few minor issues in the Getting started document 2013-10-20 23:44:19 +02:00
awiddersheim 9d141c5f34 Fixed typo in docsite/rst/playbooks_tags.rst 2013-10-18 23:00:50 -04:00
Adam Miller 5b2338b2bf fix change_when example for False 2013-10-18 13:13:13 -05:00
Greg Karékinian 86f4e03bb5 Fix typo 2013-10-17 16:00:58 +02:00
Michael DeHaan ebbf845e09 Merge pull request #4520 from jaugustin/patch-1
[doc] duplicate group in usa:children group
2013-10-15 08:23:52 -07:00
Michael DeHaan cb87a94515 Merge pull request #4519 from mmoya/fixes
Fix building of docsite
2013-10-15 08:23:32 -07:00
Jérémie Augustin ddf1d71b7d [doc] duplicate group in usa:children group 2013-10-15 17:18:07 +02:00
Maykel Moya cd051c4a0d Fix building of docsite
* Fix paths in docsite/Makefile having an additional '..'.
* Ignore generated docsite/rst/modules/*.rst
2013-10-15 16:21:19 +02:00
James Tanner 6b60267898 Document per task remote_user, based on #3932 2013-10-15 09:40:37 -04:00
Michael DeHaan 0cd09dd54f Remove extra "latest/" subdirectory in docs build structure. 2013-10-14 08:27:30 -04:00
Michael DeHaan d22529bad0 Version added info in docs for do/until was missing. 2013-10-14 08:24:43 -04:00
Michael DeHaan a956c2019f Add some notes about which features are typically rarely used so folks won't feel like they have to understand them all up front. 2013-10-13 08:57:10 -04:00
Michael DeHaan 44b5b9525f Add documents for some additional iteration types. 2013-10-13 08:54:36 -04:00
Michael DeHaan a20d5462b6 Fix rst doc macro 2013-10-12 12:41:29 -04:00
Michael DeHaan 8faaae142c Fix REST anchor targets 2013-10-12 11:20:56 -04:00
Michael DeHaan b119adf684 Add note about role search path. 2013-10-12 11:05:22 -04:00
Michael DeHaan f27a9986c1 Document standardized task/handler include syntax. 2013-10-12 10:57:11 -04:00
Michael DeHaan 6bec262b8e Add an example of failed_when. 2013-10-12 10:51:32 -04:00
Michael DeHaan fee360f33e Add example.config and main documentation of the roles_path feature. 2013-10-12 10:15:30 -04:00
Michael DeHaan 61c2eb9cb0 Just clarify there are load balancer modules :) 2013-10-12 08:34:41 -04:00
Michael DeHaan bd20d3c9be Merge pull request #4382 from jryans/devel
Tweak syntax in intro docs
2013-10-08 05:46:45 -07:00
Michael DeHaan 48f97e16e9 Add doc about password generation for user modules in the FAQ. 2013-10-08 08:38:51 -04:00
Michael DeHaan c69e19c6a6 Enhance references to logging functionality. Fixes #3431. 2013-10-08 08:26:40 -04:00
Michael DeHaan 19386c43a7 Merge 2013-10-07 10:02:21 -04:00
Michael DeHaan 8604212da9 Merge pull request #4352 from jhoekx/mysql-user-grant
Add grant parameter to MySQL user module
2013-10-07 06:08:39 -07:00
lied ef4ec735b6 Add local provisioning step notes to EC2 pages (adapted with changes by mpdehaan). 2013-10-07 08:29:03 -04:00
J. Ryan Stinnett 5f0b5e92fa Tweak syntax in intro docs 2013-10-06 23:22:34 -04:00
Chris Church 97e9d980b2 Spelling corrections for docsite. 2013-10-05 21:19:19 -04:00
Michael DeHaan a8637dbde6 Misc docs tweaking. 2013-10-05 14:57:45 -04:00
Michael DeHaan f0db5508cd Some design concepts. 2013-10-05 14:22:43 -04:00
Michael DeHaan 572fef3854 Allude to ansible-pull. 2013-10-05 14:18:12 -04:00
Michael DeHaan 95fd533d3c Add info about ansible-doc and ansible-pull. 2013-10-05 14:18:12 -04:00
Michael DeHaan 30ae97c5d0 Fix rst link. 2013-10-05 14:04:25 -04:00
Michael DeHaan 715a07d200 Sphinx formatting. 2013-10-05 13:58:03 -04:00
Michael DeHaan ade46e9aab Various docs cleanup. 2013-10-05 13:50:53 -04:00
Michael DeHaan d6168189a7 Add toctrees to pages in the docs that did not have them. 2013-10-05 13:25:05 -04:00
Michael DeHaan 4a93f9ee6d Fix some missing hyperlinks to ansible-examples on github. 2013-10-05 12:49:42 -04:00
Michael DeHaan 7891f32fc7 Does "fix malformed hyperlink target" sound any less Star-Trekky than "realign the main deflector array?". 2013-10-05 12:41:26 -04:00
Michael DeHaan b62b9bda65 Remove duplicate link to old examples dir. 2013-10-05 12:40:53 -04:00
Michael DeHaan 05321cafe1 Add see also sections to pages that do not have them. 2013-10-05 12:31:42 -04:00
Michael DeHaan 46fe4d4b92 Fix some docs formatting. 2013-10-04 20:04:31 -04:00
Michael DeHaan 6ad43c7268 Remove duplicate section, fix a link. 2013-10-04 19:06:20 -04:00
Michael DeHaan d3b916ed0a Misc docs work. 2013-10-04 19:04:09 -04:00
Michael DeHaan 7f2253451e More anchors! 2013-10-04 18:41:14 -04:00
Michael DeHaan 41909d7fd5 More exciting anchor tags, document more loop features! 2013-10-04 18:34:39 -04:00
Michael DeHaan b0d5033386 Add lots of anchor tags. 2013-10-04 18:15:04 -04:00
Michael DeHaan 111b3578d6 add more indexes, AWX blurb. 2013-10-04 18:15:04 -04:00
Michael DeHaan 198c9a5903 Adding some labels so we don't get "#id22" for the links in the docs. 2013-10-04 10:41:44 -04:00
Skylar Saveland 1f2047cc39 (docs) result is registered so would be used in the until param of a do-until loop 2013-10-03 13:28:29 -07:00
Jeroen Hoekx 08b0773da5 Add append_privs parameter to MySQL user module.
This adds the privileges given to the existing list of privileges
instead of overwriting any existing ones.
2013-10-03 14:57:01 +02:00