Commit graph

95 commits

Author SHA1 Message Date
Carlos E. Garcia
0b8011436d minor spelling changes 2016-12-13 13:51:13 -05:00
Fabio Alessandro Locati
9a9ee3a195 Improve YAML (#19174) 2016-12-10 16:30:54 -05:00
mulkieran
1fae3aecc7 Modify instances of the use of the word idempotence to be correct. (#18704)
Idempotence has a very specific meaning and it is generally not used correctly
in the manual. My attention was first drawn to this problem by the incorrect
definition in the glossary, but on further reading of the docs I found that
the problem occurred in a number of places.

Signed-off-by: mulhern <amulhern@redhat.com>
2016-12-01 14:32:55 -08:00
David Wittman
d276947a58 Fix typo in Developing Modules doc
Fix pluralization of `ANSIBLE_KEEP_REMOTE_FILES` environment
variable.
2016-10-28 23:58:17 -05:00
Will Thames
c661f9f561 Module examples should be in YAML format
Given that Ansible best practices say to use YAML format, our
documentation should not make the excuse that it's too hard,
but rather represent examples in YAML format.

This will allow those using the examples to instantly see
best practices
2016-10-15 16:51:54 -07:00
James Cammarata
1874d9e3eb Fixing typo in developing modules doc 2016-09-08 14:29:46 -05:00
Toshio Kuratomi
33245b2011 Add checklist item on how to use env vars with basic auth helpers 2016-08-31 09:33:33 -07:00
Toshio Kuratomi
7e71299ee1 Couple things to watch out for when reviewing facts modules 2016-08-25 11:37:57 -07:00
Scott Butler
9abd20d49b Edited https://github.com/ansible/ansible/pull/17128 2016-08-19 11:22:21 -07:00
Brian Coca
dac5af63cb corrected typo, expanded server types 2016-08-17 15:49:40 -04:00
Brian Coca
b581780283 dont do it 2016-08-17 15:45:31 -04:00
Scott Butler
12ce5a24da Minor wordsmithing. 2016-08-08 16:33:07 -07:00
Brian Coca
9a9268de0f version_added is required for new modules/options 2016-08-08 19:14:13 -04:00
Brian Coca
dd12a6b310 document 'no booleans in choices' 2016-08-04 10:41:50 -04:00
Brian Coca
de7b0e9da1 made def main an explicit requirement 2016-05-24 15:11:00 -04:00
Toshio Kuratomi
9ef814e782 Documentation fixes 2016-05-24 10:46:33 -07:00
Toshio Kuratomi
0d16782a22 Python3 syntax compatibility for modules 2016-05-18 17:03:48 -07:00
Matt Davis
ec2cb07988 Make 'required' optional in module docs (#15906)
Updated module dev docs, doc build, ansible-doc to match
2016-05-18 16:57:36 -07:00
Matt Martz
2e8146c52f Improve documentation about the JSON args file 2016-05-12 12:25:09 -05:00
Matt Martz
a4d2238e50 Bumping binary modules functionality to 2.2 2016-05-12 12:25:09 -05:00
Matt Martz
c22c1b4785 Add note about reading input for binary modules 2016-05-12 12:25:09 -05:00
Toshio Kuratomi
4f7a0925fd Corrections to documentation formatting 2016-05-04 12:18:02 -07:00
Toshio Kuratomi
2e86260e17 Update Program flow documentation for new way that ziploader works
Add documentation on how to debug ziploader modules
2016-04-24 20:46:05 -07:00
Sandra Wills
4822c2caa5 minor typo fixes
fixed a few minor typos in the intro for the section
"Deprecating and making module aliases"
2016-04-13 13:57:23 -04:00
Sandra Wills
59456af8be attempting to wrangle feedback from git comments.
please edit specific lines when possible to ensure your feedback
is incorporated properly. thanks!
2016-04-13 13:57:04 -04:00
Sandra Wills
640f4e79bd trying the new content in the checklist instead of new sections
per bcoca's comment, thought I would move the new content to the checklist
to see if you guys think this is a better treatment.
2016-04-13 13:55:35 -04:00
Sandra Wills
c3a086a55e adding links and anchors for links, referencing check mode 2016-04-13 13:51:29 -04:00
Sandra Wills
f9d9cb8245 start of merge from google doc and team comments, module guidelines as focus, added a link anchor as needed 2016-04-13 13:51:25 -04:00
jjshoe
f713a5412a Document argument true/false preferences 2016-04-11 12:05:34 -05:00
SUNTRUP
3bfb556cb9 Clarify developing modules documentation
This resolves issue #15022. When doing the module tutorial, it might be
necessary for the user to read through the documentation for installing
from source to avoid dependency errors and such.
2016-03-18 09:12:17 -05:00
Adam Hartz
cebf127d68 Change reference to basic.py, where the implementation details live 2016-02-16 10:32:57 -05:00
Adam Hartz
327b27ba1c Update stated location of common_module.py 2016-02-16 09:48:40 -05:00
Greg DeKoenigsberg
f3336fba44 Tweaking Python 2.4 requirement 2016-01-21 13:02:03 -05:00
Greg DeKoenigsberg
981e9c44ba Put Python 2.4 in checklist
It's in the travis check, but we don't spell it out explicitly in the guidelines.
2016-01-21 12:22:26 -05:00
Michael
519952d7d7 Fix module name 2016-01-07 00:08:49 -08:00
mgarstecki
5accc98587 Correction of a double negation
The sentence seemed to imply that return codes from modules are significant, while they are not. The second part of the sentence confirms this, as it advises to use standard return codes only for future proofing.
2015-12-30 11:57:12 +01:00
Brian Coca
b201cf2ee1 switched from pythonic None to generic null 2015-12-23 10:30:24 -05:00
Toshio Kuratomi
b33f72636a Also remove the bool casting function info (transparent to module writer now) 2015-12-22 07:25:50 -08:00
Toshio Kuratomi
b310d0ce76 Update the developing doc to modern method of specifying bool argspec values 2015-12-22 07:23:51 -08:00
Michael Scherer
fe72fff57d Fix the markdown used for the Windows module section 2015-12-10 02:00:31 +01:00
Raphael Badin
20a45ab36d Fix missing word in developing_modules.rst 2015-11-25 18:29:17 +01:00
Will Thames
ab55726fad Clarify module documentation
Make the position on _facts modules more emphatic
Add documentation for RETURN structure
2015-10-29 10:02:59 +10:00
=
345ce424c6 Explictly set the version of strict mode to use for powershell modules. 2015-10-07 06:24:37 +01:00
Trond Hindenes
e9786db541 Windows: Updated docs to reflect the new name of get-attr, along with examples 2015-09-30 23:29:05 +02:00
Nathaniel Schaaf
ffc67f0a37 Fix spelling 2015-09-16 10:48:23 -05:00
James Cammarata
2a32384a2c Merge pull request #12227 from arbabnazar/patch-1
Update developing_modules.rst
2015-09-03 11:42:14 -04:00
Praveen Kumar
6e1f7cd503 Fix typo to avoid traceback during testing 2015-09-03 16:35:17 +05:30
Arbab Nazar
d2e547c31f Update developing_modules.rst 2015-09-03 11:27:56 +05:00
Greg DeKoenigsberg
ee7f7a82a8 Update developing_modules.rst
More specific about urllib2 restrictions
2015-08-28 15:19:54 -04:00
Greg DeKoenigsberg
ec95ad1062 Update developing_modules.rst 2015-08-28 14:30:16 -04:00