1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Commit graph

1576 commits

Author SHA1 Message Date
Matt Martz
a5f05c6fc2 [WIP] Start of subelements filter (#39829)
* Start of subelements filter

* Add docs for subelements filter
2018-05-23 11:54:13 -04:00
Jordan Borean
070a5557d1
always_run: removed deprecated always_run task option (#40470) 2018-05-23 07:10:36 +10:00
Matt Clay
4b2bba62b3 Update 2.6 roadmap schedule. 2018-05-22 10:57:51 -07:00
Alicia Cozine
69eef14e3b uses .txt for shared content (#40416) 2018-05-22 12:01:00 +01:00
Matt Clay
8d39515914 Remove tab check from validate-modules.
It is redundant with the pycodestyle W191 "indentation contains tabs" check.
2018-05-21 14:45:19 -07:00
Matt Clay
47173cc8b1 Clarify wording on 2.6 roadmap schedule. (#40408)
* Clarify wording on 2.6 roadmap schedule.

* Remove redundant use of "Core".
2018-05-18 13:39:10 -05:00
Brian Coca
5cf1a5edfd corrected version added 2018-05-18 11:34:37 -04:00
Simon
fb6ae90f60 Memset: initial module, integration tests, module_utils and supporting documentation. (#40071)
*  * Memset:
   * module_utils and associated documentation.
   * module to manage DNS zones.
   * integration tests to run against Memset's API.

* * memset.py:
  * remove import of requests from memset.py in favour of internal Ansible modules.
  * import necessary Ansible modules for request and response handling.
  * create a response object in order to retain a stable interface to memset_api_call from existing modules.
  * rework memset_api_call to remove requests.
* memset_zone.py:
  * improve short description to be more verbose.
  * ensure all imports directly follow documentation.
  * remove any reference to requests.
  * correct keyerror carried over from elsewhere.

* remove dependency on requests from documentation string

* disable integration tests until we have a cleanup method available
2018-05-18 10:45:38 +01:00
Nathaniel Case
e9d7fa0418
HTTP(S) API connection plugin (#39224)
* HTTPAPI connection

* Punt run_commands to cliconf or httpapi

* Fake enable_mode on eapi

* Pull changes to nxos

* Move load_config to edit_config for future-preparedness

* Don't fail on lldp disabled

* Re-enable check_rc on nxos' run_commands

* Reorganize nxos httpapi plugin for compatibility

* draft docs for connection: httpapi

* restores docs for connection:local for eapi

* Add _remote_is_local to httpapi
2018-05-17 18:47:15 -04:00
Sam Doran
59e541e31a
Change behavior to behaviour in docs and tests (#39392)
* Change behavior to behaviour

- use existing fact to get hash setting rather than shell task
- fix code highlighting syntax in playbooks_variables.rst

* Re-wrote intro section; this entire topic needs a clean-up/rewrite.
2018-05-17 14:07:12 -04:00
Alexandre Chaussier
e493891d08 Fix flatten filter documentation 2018-05-17 10:42:41 -04:00
Ganesh Nalawade
1328cc1fa0
Update ROADMAP_2_6.rst 2018-05-17 16:10:35 +05:30
Ganesh Nalawade
c86860c911
Update ROADMAP_2_6.rst 2018-05-17 15:54:51 +05:30
Deepak Agrawal
4fd770f792
Update ROADMAP_2_6.rst 2018-05-17 11:57:50 +05:30
Toshio Kuratomi
6227c2ac75
More file refactoring (#40114)
* Set src in the state functions rather than the toplevel

A good API should only require passing one version of a piece of data
around so do that for src

* Move the rewriting of path into additional_parameter_handling

When the path is a directory we can rewrite the path to be a file inside
of the directory

* Emit a warning when src is used with a state where it should be ignored
2018-05-16 10:41:11 -07:00
Ken Celenza
ad1a7d90ff Update structure to include file extensions (#36967)
* Update structure to include file extensions

It is not clear to novice users that the host/group_vars files should be yaml files. This highlights that IMHO a bit more clearer.

* pluralize
2018-05-16 12:19:21 -04:00
Trishna Guha
465114958e
remove network_config,network_command from roadmap_2.6 (#40246)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-05-16 18:51:51 +05:30
Alicia Cozine
64f87867dd documents usage of enable mode on NXOS (#39859) 2018-05-15 20:04:24 +01:00
Felix Fontein
f16933492d Fix problems in documentation generation (#40050)
* Treat C(...) as inline literal (as opposed to interpreted text).

* Making test for true and false more precise, to avoid matching 1, 1.0, etc.

* The 'is sameas' test already takes care of definedness.
2018-05-15 16:19:04 +02:00
Trishna Guha
6e639b591f
networking roadmap cli modules (#40147)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-05-15 18:31:42 +05:30
Jordan Borean
e0813d7d47
become win: better error messages and docs update (#39936)
* become win: better error messages and docs update

* Fix syntax error and added changelog fragment
2018-05-15 09:33:36 +10:00
Jon Dufresne
1d640182c6 Update all pypi.python.org URLs to pypi.org (#38988)
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-05-14 17:41:47 -05:00
Brian Coca
32c2aae258
document lookup errors optoin (#39645)
* document lookup errors optoin

* changed to doc

* updated as per feedback
2018-05-11 15:09:53 -04:00
Steve McLellan
5fd9954ccc Remove duplicate include in user_guide
Looks like two commits merged close to each other and an '-include'
got left along with its replacement '-include_tasks'
2018-05-10 16:42:35 -04:00
Chris Alfonso
02adb6520f Removing stretch items for 2.6 roadmap (#39757)
* netconf modules
  * gRPC connection plugin
2018-05-10 14:03:49 +01:00
Ewoud Kohl van Wijngaarden
e4efc191c5 Fix code snippet in playbook filters doc (#39798) 2018-05-10 12:05:24 +10:00
Ken Celenza
e476089bb9 spacing issue (#39884) 2018-05-09 10:08:59 +02:00
Cameron
854be6ef16 docs: fix 'ipmi' typo (#39823) 2018-05-08 09:15:56 +02:00
David Moreau Simard
8c27ffdf90 Add ARA Records Ansible to community tools (#39836)
ARA is an Ansible callback that records playbook run data in a local
or remote database. This data is exposed through a CLI client as well
as a reporting web application.
2018-05-07 22:18:52 -04:00
Matt Martz
1663b64e18
Allow subspec defaults to be processed when the parent argument is not supplied (#38967)
* Allow subspec defaults to be processed when the parent argument is not supplied

* Allow this to be configurable via apply_defaults on the parent

* Document attributes of arguments in argument_spec

* Switch manageiq_connection to use apply_defaults

* add choices to api_version in argument_spec
2018-05-07 11:23:13 -05:00
Elias
7f5820274f Update call method for parse_cli_textfsm (#38437)
+label: docsite_pr
2018-05-07 09:43:45 -05:00
Jordan Borean
fc210a4584
base64 filter: Added ability to specify encoding (#39714)
* base64 filter: Added ability to specify encoding

* Added unicode chars for further testing

* Removed errors to keep previous behaviour in place

* Removed surrogate pairs due to issues loading YAML in CI
2018-05-05 09:16:58 +10:00
Julien Palard
ab4cbfd5d3 FIX: Removing superfluous bloc wrongly introduced in 2b7799f817. (#39723) 2018-05-04 10:45:33 +02:00
Kevin Breit
c8d287fece Meraki organization module (#38773)
* Initial commit

Query an organization within Meraki. No support is in place for managing
or creating yet

* Change output_level method and make the state parameter required.

* Implemented listing all organizations

- Updated documentation
- Parse results and return all organizations
- Parse results and return specified organization

* Framework for creating an organization

- Documentation example for organization creation
- Framework exists for creating organizations, pending PR 36809
- Created functions for HTTP calls
- Renamed from dashboard.meraki.com to api.meraki.com
- Added required_if for state

* Remove absent state

- Meraki API does not support deleting an organization so absent is removed
- Updated documentation to call it state instead of status

* Small change to documentation

* Support all parameters associated to organization

- Added all parameters needed for all organization actions.
- None of the added ones work at this time.
- Added documentation for clone.

* Integration test for meraki_organization module

* Rename module to meraki for porting to module utility

* Meraki documentation fragment

- Created initial documentation fragment for Meraki modules

* Add meraki module utility to branch. Formerly was on a separate branch.

* CRU support for Meraki organization module

* CRU is supported for Meraki organizations
* There is no DELETE function for organizations in the API
* This code is very messy and needs cleanup
* Create and Update actions don't show status as updated, must fix

* Added Meraki module utility to module utility documentation list

* Added support for organization cloning
* Renamed use_ssl to use_https
* Removed define_method()
* Removed is_org()
* Added is_org_valid() which does all org sanity checks

* Fixes for ansibot
- Changed default of use_proxy from true to false
- Removed some commented out code
- Updated documentation

* Changes for ansibot
- Removed requirement for state parameter. I may readd this.
- Updated formatting

diff --git a/lib/ansible/module_utils/network/meraki/meraki.py b/lib/ansible/module_utils/network/meraki/meraki.py
index 3acd3d1038..395ac7c4b4 100644
--- a/lib/ansible/module_utils/network/meraki/meraki.py
+++ b/lib/ansible/module_utils/network/meraki/meraki.py
@@ -42,7 +42,7 @@ def meraki_argument_spec():
     return dict(auth_key=dict(type='str', no_log=True, fallback=(env_fallback, ['MERAKI_KEY'])),
                 host=dict(type='str', default='api.meraki.com'),
                 name=dict(type='str'),
-                state=dict(type='str', choices=['present', 'absent', 'query'], required=True),
+                state=dict(type='str', choices=['present', 'absent', 'query']),
                 use_proxy=dict(type='bool', default=False),
                 use_https=dict(type='bool', default=True),
                 validate_certs=dict(type='bool', default=True),
diff --git a/lib/ansible/modules/network/meraki/meraki_organization.py b/lib/ansible/modules/network/meraki/meraki_organization.py
index 923d969366..3789be91d6 100644
--- a/lib/ansible/modules/network/meraki/meraki_organization.py
+++ b/lib/ansible/modules/network/meraki/meraki_organization.py
@@ -20,11 +20,9 @@ short_description: Manage organizations in the Meraki cloud
 version_added: "2.6"
 description:
 - Allows for creation, management, and visibility into organizations within Meraki
-
 notes:
 - More information about the Meraki API can be found at U(https://dashboard.meraki.com/api_docs).
 - Some of the options are likely only used for developers within Meraki
-
 options:
     name:
         description:
@@ -32,21 +30,18 @@ options:
         - If C(clone) is specified, C(name) is the name of the new organization.
     state:
         description:
-        - Create or query organizations
-        choices: ['query', 'present']
+        - Create or modify an organization
+        choices: ['present', 'query']
     clone:
         description:
         - Organization to clone to a new organization.
-        type: string
     org_name:
         description:
         - Name of organization.
         - Used when C(name) should refer to another object.
-        type: string
     org_id:
         description:
         - ID of organization
-
 author:
     - Kevin Breit (@kbreit)
 extends_documentation_fragment: meraki
@@ -86,7 +81,6 @@ RETURN = '''
 response:
     description: Data returned from Meraki dashboard.
     type: dict
-    state: query
     returned: info
 '''

@@ -103,6 +97,7 @@ def main():
     argument_spec = meraki_argument_spec()
     argument_spec.update(clone=dict(type='str'),
+                         state=dict(type='str', choices=['present', 'query']),
                          )

@@ -125,11 +120,9 @@ def main():

     meraki.function = 'organizations'
     meraki.params['follow_redirects'] = 'all'
-    meraki.required_if=[
-                           ['state', 'present', ['name']],
-                           ['clone', ['name']],
-                           # ['vpn_PublicIP', ['name']],
-                       ]
+    meraki.required_if = [['state', 'present', ['name']],
+                          ['clone', ['name']],
+                          ]

     create_urls = {'organizations': '/organizations',
                    }
@@ -162,23 +155,16 @@ def main():

-
-    # method = None
-    # org_id = None
-
-
-    # meraki.fail_json(msg=meraki.is_org_valid(meraki.get_orgs(), org_name='AnsibleTestOrg'))
-
     if meraki.params['state'] == 'query':
-      if meraki.params['name'] is None:  # Query all organizations, no matter what
-        orgs = meraki.get_orgs()
-        meraki.result['organization'] = orgs
-      elif meraki.params['name'] is not None:  # Query by organization name
-        module.warn('All matching organizations will be returned, even if there are duplicate named organizations')
-        orgs = meraki.get_orgs()
-        for o in orgs:
-          if o['name'] == meraki.params['name']:
-            meraki.result['organization'] = o
+        if meraki.params['name'] is None:  # Query all organizations, no matter what
+            orgs = meraki.get_orgs()
+            meraki.result['organization'] = orgs
+        elif meraki.params['name'] is not None:  # Query by organization name
+            module.warn('All matching organizations will be returned, even if there are duplicate named organizations')
+            orgs = meraki.get_orgs()
+            for o in orgs:
+                if o['name'] == meraki.params['name']:
+                    meraki.result['organization'] = o
     elif meraki.params['state'] == 'present':
         if meraki.params['clone'] is not None:  # Cloning
             payload = {'name': meraki.params['name']}
@@ -193,7 +179,10 @@ def main():
             payload = {'name': meraki.params['name'],
                        'id': meraki.params['org_id'],
                        }
-            meraki.result['response'] = json.loads(meraki.request(meraki.construct_path('update', org_id=meraki.params['org_id']), payload=json.dumps(payload), method='PUT'))
+            meraki.result['response'] = json.loads(meraki.request(meraki.construct_path('update',
+                                                                                        org_id=meraki.params['org_id']),
+                                                                  payload=json.dumps(payload),
+                                                                  method='PUT'))

diff --git a/lib/ansible/utils/module_docs_fragments/meraki.py b/lib/ansible/utils/module_docs_fragments/meraki.py
index e268d02e68..3569d83b99 100644
--- a/lib/ansible/utils/module_docs_fragments/meraki.py
+++ b/lib/ansible/utils/module_docs_fragments/meraki.py
@@ -35,6 +35,7 @@ options:
         description:
         - Set amount of debug output during module execution
         choices: ['normal', 'debug']
+        default: 'normal'
     timeout:
         description:
         - Time to timeout for HTTP requests.
diff --git a/test/integration/targets/meraki_organization/aliases b/test/integration/targets/meraki_organization/aliases
new file mode 100644
index 0000000000..ad7ccf7ada
--- /dev/null
+++ b/test/integration/targets/meraki_organization/aliases
@@ -0,0 +1 @@
+unsupported

* Formatting fix

* Minor updates due to testing
- Made state required again
- Improved formatting for happier PEP8
- request() now sets instance method

* Fix reporting of the result

* Enhance idempotency checks
- Remove merging functionality as the proposed should be used
- Do check and reverse check to look for differences

* Rewrote and added additional integration tests. This isn't done.

* Updated is_update_required method:
- Original and proposed data is passed to method
- Added ignored_keys list so it can be skipped if needed

* Changes per comments from dag
- Optionally assign function on class instantiation
- URLs now have {} for substitution method
- Move auth_key check to module utility
- Remove is_new and get_existing
- Minor changes to documentation

* Enhancements for future modules and organization
- Rewrote construct_path method for simplicity
- Increased support for network functionality to be committed

* Changes based on Dag feedback and to debug problems

* Minor fixes for validitation testing

* Small changes for dag and Ansibot
- Changed how auth_key is processed
- Removed some commented lines
- Updated documentation fragment, but that may get reverted

* Remove blank line and comment

* Improvements for testing and code simplification
- Added network integration tests
- Modified error handling in request()
	- More testing to come on this
- Rewrote construct_path again. Very simple now.

* Remove trailing whitespace

* Small changes based on dag's response

* Removed certain sections from exit_json and fail_json as they're old
2018-05-04 00:01:05 +02:00
scottb
0c0dc8d9fc
Adds documentation structure and stubs for new VMWare guide (#39246)
* Adding initial skeleton of VMWare docs

* Updated product name capitaliztion; ready for initial PR.

* Add few files and updated some links

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Fixed duplicate anchor tag
2018-05-03 08:05:28 -07:00
Toshio Kuratomi
1885883a88 Document follow changes
Add the file, blockinfile, and replace changes to the follow parameter
to the porting guide
2018-05-03 06:13:21 -07:00
Anna Liao
c812396793 Update playbooks_variables.rst (#39570)
<!--- Your description here -->

+label: docsite_pr
2018-05-01 23:02:32 -07:00
Abhijeet Kasurde
85ad2eae8a Fix typo in porting guides index page (#39582)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-05-01 23:00:59 -07:00
Matt Clay
054efb8d80
Update 2.6 roadmap dates. (#39573) 2018-05-01 15:07:37 -07:00
Andrew Gaffney
4134f1204b Add Andrew Gaffney to list of people in Committers Guidelines doc 2018-05-01 12:51:34 -07:00
Brian Coca
19fee0ef41 fix keyword doc generation
* use aliases when they exist
  * fix hardcoded loop attributes handling
2018-04-30 14:47:09 -04:00
Andrius Benokraitis
9773157da6 Update intermediate_concepts.rst (#39500)
Updated  GitHub Repos section to better explain what ansible-network@redhat.com is for (not an email list, but adding to the network-automation github repo.
2018-04-30 09:29:37 -05:00
Alicia Cozine
c8a9b411bc
Last docs link fixes (#39391)
* should not need <>, but fails without

* adds anchor to keywords page, uses it on plugins pages

* fixes envvar link errors

* harmonize file name and ref name as python_3

* removes undefined-lable from ignore list
2018-04-27 13:21:39 -05:00
Abhijeet Kasurde
9f1254a32f Typo fix in testing link (#39407)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-04-27 01:16:12 -07:00
Matt Clay
32d786af65 Convert more http links to https. 2018-04-25 23:12:46 -07:00
Lucid One
40fcef3e41 Adding support for opensearch of documentation (#38593) 2018-04-25 18:01:26 -07:00
Jordan Borean
f8853d83e3
windows: removed deprecated features in 2.6 (#38930)
* windows: removed deprecated features in 2.6

* Comma surgery.
2018-04-26 06:13:37 +10:00
Alicia Cozine
4b52a54e18 Reduce warnings (#39254)
* removes FAQ links; no entries exist for linked config settings

* fixes various anchors and links

* addresses abadger comments, thanks

* marks orphan pages, avoids TOC errors

* adds links for remote_tmp setting to FAQ
2018-04-25 11:18:52 -07:00
Matt Martz
476d1f818e
Documentation for query/q. Fixes #38275 (#38558) 2018-04-25 12:55:34 -05:00
Matt Clay
7975c8fab0
Improve integration-aliases docs. (#39087) 2018-04-24 14:25:53 -07:00
Brian Coca
b533ebe20d
remove slice docs (#37946) 2018-04-24 11:11:46 -04:00
Andrius Benokraitis
7881866db4 Update ROADMAP_2_6.rst with additional network roadmap items (#39225)
* Update ROADMAP_2_6.rst

Added network_get and network_put to Network modules roadmap

* Update ROADMAP_2_6.rst

add netconf_config to the network module roadmap
2018-04-24 15:55:12 +01:00
Alicia Cozine
8f83061e70 corrects links to 'list_of' pages (#39161) 2018-04-24 15:51:12 +01:00
Alicia Cozine
becc2a0347 adds index page for roadmaps to support internal links (#39109)
* adds index page for roadmaps to support internal links

* includes only roadmaps index page in TOC
2018-04-23 12:22:44 -07:00
Alicia Cozine
0fef3f1b48 avoids not-in-toc errors with :orphan: 2018-04-23 12:14:43 -07:00
Matt Clay
c262dbfd30 Use https for links to ansible.com domains. 2018-04-23 11:33:56 -07:00
saichint
6eecbf10e6 fix nxos_igmp_interface issues (#38752)
* fix nxos_igmp_interface issues

* shippable fix

* fix oif_prefix and oif_source

* shippable fix

* shippable fix

* shippable fix

* add an example for oif_ps

* review comments

* review comments

* more review comments

* fix typo
2018-04-23 20:38:49 +05:30
Josh
aa9d7cb1f3 Update playbooks_debugger.rst (#39117)
Minor typo correction

+label: docsite_pr
2018-04-23 10:37:40 +02:00
Benn Roth
56967497d5 minor accuracy fix
Don't round the parameter 12.04 in the explanatory paragraph unless `version()` rounds the parameter

(cherry picked from commit 5cf544e03e5f833e1614fa940849976550d55448)
2018-04-20 19:14:39 -04:00
Alicia Cozine
bbfd6c6ab1 Internal refs (#39094)
* fixes community refs

* fixes appendix refs

* fixes scenario refs, keeps ACI guide link to devel

* fixes windows refs

* fixes user guide refs

* fixes dev guide refs
2018-04-20 12:17:02 -07:00
John R Barker
c4e298b808 Correct to development_process (#39069) 2018-04-20 12:36:29 -05:00
John R Barker
ebdf6d0fab
Add missing > to fix 'edit this document' link (#39067) 2018-04-20 11:31:17 +01:00
Salvatore Mesoraca
aaf2ff629d Fix formatting error in rst plugin template (#38956)
The hyperlink syntax used is wrong and the resulting
rendered documents have broken links.
2018-04-20 13:48:28 +05:30
Matt Clay
9e8889bb70
Fix more docs errors. (#39051)
* Fix remaining unknown-document docs errors.
* Fix last toc-tree-missing-document docs error.
2018-04-20 00:24:47 -07:00
Matt Clay
7e96421132
Handle warnings in docs-build sanity test. (#39043) 2018-04-19 23:09:48 -07:00
Matt Clay
4fc5e89e83 Fix docs build warnings. 2018-04-19 17:54:56 -07:00
Alicia Cozine
64dcc7def0 Fixes more rST errors (#39042)
* removes include, avoids duplicate label rST warnings

* reduces literal_block errors on playbooks_filters

* addresses TOC errors

* ref error on modules page

* trying ref for list_of_database_modules
2018-04-19 17:02:48 -07:00
Alicia Cozine
408e29cbd2 Link fixes (#39038)
* fixes links on plugins pages

* fixes links in community pages

* fixes links in user guide

* adds anchors on playbooks pages
2018-04-19 17:02:30 -07:00
Toshio Kuratomi
6ddc64bc7c Fixes for multiline doc descriotions breaking rst formatting
* strip whitespace to preserve indent level
* Make sure to indent subsequent lines of indentation
2018-04-19 11:37:37 -07:00
Toshio Kuratomi
a08459a814
Update info on python support (#38855)
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

  * virtualenv info (previously on the python3 support page)
  * BSD (Link to the working with BSD page)
  * Solaris (Document how to work around the non-POSIX shell on some
    Solaris hosts)

  Fixes #21594

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:

ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

* Make wording for Solaris troubleshooting better.
2018-04-18 13:04:47 -07:00
Alicia Cozine
0ebc0b9e5a adds FAQ TOC entry, links & examples to modules (#38706)
* adds FAQ TOC entry, links & examples to modules
* moves link to Notes, corrects examples
2018-04-18 11:41:54 -07:00
Toshio Kuratomi
8cdd75a09f Some more fixes for the docs :ref: disambiguation
The big one is that we needed to set plugin_type when we processed the by_support template.

Also added to list_of_CATEGORY_plugins page (which might not be used)
and corrected a place where I did module_name instead of name_module
2018-04-18 10:06:01 -07:00
Brian Coca
ce8c336d52 added ref to ansilbe molecule 2018-04-18 12:19:09 -04:00
Toshio Kuratomi
9faf7b949e Fix places in docs that refer to modules without namespace
We've namespaced all plugin docs.  Change the docs to reflect that
2018-04-18 08:43:34 -07:00
Toshio Kuratomi
f9d83944ec regex for finding :ref: labels was flawed
The regex to find labels inside of angle brackets was not detecting
anything before so I missed all of those.
* Fixed the regex in find-plugin-refs to take care of that.
* Fixed plugin_formatter to emit namespaced labels for the M() macro.
2018-04-18 08:43:34 -07:00
Martin Krizek
8173602a34
Add expandvars jinja2 filter (#38805)
* Add expandvars jinja2 filter

* Add docs

* Minor edit
2018-04-18 09:29:19 +02:00
scottb
c97e508806
[WIP] disambiguating autogenerated module docs attempted fix of #38439. (#38890)
Disambiguates autogenerated module docs - fixes #38439.
2018-04-17 18:45:07 -07:00
Matt Clay
3d57f45815 Update httptester docs. 2018-04-17 15:02:56 -07:00
Toshio Kuratomi
a1b148d190 Fix shebang so sanity tests pass 2018-04-17 15:01:29 -07:00
Toshio Kuratomi
1f0cc54ec7 fixup style problems in new script 2018-04-17 15:01:29 -07:00
Toshio Kuratomi
6b1e6b8460 Add a script for finding bare plugin :ref:s
We're porting autogenerated plugin docs so that :ref: targets are
namespaced by plugin type.  To do this effectively, we need to know
where all the :ref: targets which refer to the bare plugin names are in
the rst files.  This script will find those.
2018-04-17 15:01:29 -07:00
Evgeniy Komissarov
92f4065157 Fix typo in windows_faq.rst (#38864)
Fix typo in `python-pip` packet name.
+label: docsite_pr
2018-04-18 07:55:57 +10:00
John R Barker
3d3781db57
Correct formatting (#38874) 2018-04-17 13:19:04 +01:00
Brian Coca
bdbb89378f
centralize doc/config plugin lists (#38775)
* centralize doc/config plugin lists

also update list for generation in docsite
added note to ensure they are in sync

* updated shell page to list plugins

added some more docs hinting at plugins being configurable

* fix edit link for plugins
2018-04-16 09:29:49 -04:00
Kenyon Ralph
3c6a362921 playbooks_async.rst: correct typo 2018-04-16 09:03:39 -04:00
Rémy Léone
d639d5dc96 Fix typo (#38652)
Typo
+label: docsite_pr
2018-04-13 14:15:26 -04:00
CsilLAB
521ea56e77 Add details to see decrypted vault value (#37341)
* Improves ansible-vault section of network getting started
2018-04-12 19:52:34 -05:00
Toshio Kuratomi
25523666ce Modules that have a link to their own deprecated section need to use a different link syntax (#38697)
The :ref: syntax is for linking to targets which are defined for the
whole document tree.  `link`_ is for linking to targets which are inside
of the document.  We want the latter for deprecated sections because
otherwise we'd have to create namespaced link targets for them.

Also fix expansion of version a deprecated module will be removed in
2018-04-12 17:24:14 -07:00
Matt Clay
26fa3adeab Add docs-build sanity test. 2018-04-12 15:56:49 -07:00
Will Thames
4ba29c8bf1 Use a temp directory that is more likely to exist (#38645)
`env:SystemDrive\temp` does not necessarily exist

`env:temp` is much more likely to exist. Use that
2018-04-12 14:16:18 +10:00
Qasim Sarfraz
6d830166e9 Minor typo fix (#38589) 2018-04-12 13:47:48 +10:00
Evgeni Golov
7376a9b946 fix with_<lookup> spelling (#38584)
trivial change ;)

+label: docsite_pr
2018-04-11 15:37:33 -07:00
Alicia Cozine
da6d2b5f43 corrects Junos network_cli example & variables (#38601)
* corrects Junos network_cli example & variables

* vdacosta feedback, thanks
2018-04-11 15:36:40 -07:00
Alicia Cozine
ea99cf3231 inaugural Network FAQ (#38359) 2018-04-11 15:35:42 -07:00
Martin Krizek
5297eac46d
playbooks_variables.rst: fix facts code-block (#38520) 2018-04-11 20:46:27 +02:00
Martin Krizek
f1e41cbb36
playbooks_intro.rst: remove duplicite playbook (#38521) 2018-04-11 20:45:59 +02:00
scottb
6454aedb44
Reinstate code of conduct to the community TOC; add links to code of conduct to a few conspicuous spots in the community guide. (#38501) 2018-04-09 16:16:45 -07:00
alekseyp
061ecac3b5 Update playbooks_loops.rst (#38440)
Missing parentheses
+label: docsite_pr
2018-04-09 12:49:34 +02:00
Pierre Templier
1e0df01980 Small typos in docs (#38371)
* Small typos in docs

* Use same wording as in porting_guide_2.5.rst
2018-04-09 12:49:10 +02:00
Abhijeet Kasurde
8bc7af2e34 Minor typo in installation guide (#38452)
Change subsription-manger to subscription-manager

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-04-08 14:41:59 -07:00
scottb
d1d15dd025
Mobile CSS update - adds scrolling inertia (#38443) 2018-04-07 16:37:54 -07:00
Will Thames
a8953fcac4 Add documentation on dict2items (#38375)
dict2items is worth mentioning in the filters and loops pages
(the latter as it's useful to replace `with_dict`)

Update some nearby broken links
2018-04-07 02:13:19 -07:00
scottb
785964ea97
Tweaks docs CSS to fix minor issue with main content page display cutting off at the bottom. (#38432) 2018-04-06 20:34:31 -07:00
Toshio Kuratomi
f1b63f435e The ssh change note has been removed
Since the note was about 2.0 versus 1.x, this has been removed.  The
file implementing it is gone so we need to stop referencing it.
2018-04-06 12:04:19 -07:00
scottb
2381d2207e
Additional docs CSS fix for mobile (#38376) 2018-04-05 23:59:18 -07:00
scottb
79c5a34b0b
Fixes CSS so docs display properly on mobile (#38373) 2018-04-05 23:20:24 -07:00
Pierre Templier
2340ca7701 Small typos in docs (#38370)
* Small typos in docs

* Fixed wording
2018-04-05 22:20:51 -07:00
Elijah Lynn
95d40bcd0a Update fish setup to use source instead of . (#33207)
"The use of . is deprecated in favour of source, and . will be removed in a future version of fish."

source: https://fishshell.com/docs/current/commands.html#source
2018-04-05 11:51:55 -07:00
Brian Coca
c62551c1b0 Update role doc examples (#37844)
* fix role examples

- also fixed issue with overload of 'name', fixes #37836
- attempted to clarify tag inheritance/application

* Typo fix
2018-04-05 11:41:25 -07:00
Brian Coca
5ad13d66aa documented actual precedence (#38009)
fixes #22025
2018-04-05 11:09:11 -07:00
Christian Fetzer
9cca9a9c10 docs: Document disabling diff on task level (#37998)
* docs: Document disabling diff on task level

Tasks that deal with secrets may leak sensitive information when
running in Check Mode. This change updates the documentation explaining
that the diff can be deactivated on task level.

The feature was requested in #14860 and got introduced in Ansible 2.4
with #28581.

* Updated for clarity
2018-04-05 11:08:30 -07:00
Pilou
2a604f6fe6 doc: index_var: fix version added (#37982)
e9b0a4ccb4 is present since v2.5.0b1
2018-04-05 11:06:14 -07:00
Jonas Meurer
55fd3d62fb Update porting_guide_2.5.rst (#37927)
The example regarding `include_*` is a bit unclear. First it seems like the v2.4 and v2.5 examples are the same. So I attempted to make the relevant change in the examples more obvious.

 label: docsite_pr
2018-04-05 11:05:38 -07:00
Dag Wieers
cdf9e39647 Fix the automatic docsite_pr label (#37999) 2018-04-05 10:48:37 -07:00
Sam Doran
34dca85417 Update installation docs for RHEL based distributions. (#38056)
Upstream rpms are no longer in Extras but EPEL as well as releases.ansible.com.
Add instructions for adding Ansible Engine repo to RHEL.
2018-04-05 10:46:46 -07:00
ewubnhn
ea9ece8e72 Update spelling_word_choice.rst (#38113)
Added missing format string on "Installer"

 label: docsite_pr
2018-04-05 10:45:42 -07:00
Alicia Cozine
24fe8674a6 DOCS: Network Best Practices fixes (#38293)
* fixes typo per #38217, corrects link anchor

* adds ssh-agent info per #35649
2018-04-05 10:44:27 -07:00
Scott Butler
62c2b9a544 Removes modules from TOC, speeding up build time and reducing doc disk space requirements. 2018-04-04 20:36:01 -07:00
Toshio Kuratomi
4165bb308b Fix 2.5 changelog link 2018-04-04 14:39:38 -07:00
Toshio Kuratomi
8f1b5fc47b Add alias's as a :ref: target for modules
This is especially important for deprecated modules as we want to link
to those in porting guides and such.
2018-04-04 14:31:14 -07:00
Toshio Kuratomi
73c80862c8 Update docs and version definitions for the 2.4.4 and 2.5.0 releases 2018-04-04 14:21:04 -07:00
Dylan Silva
45b5a486c6 2.6 roadmap doc (#37926)
* 2..6 roadmap doc

* Formatting & network items

* typo
2018-04-04 18:26:19 +01:00
Alicia Cozine
380c074808 demonstrates best practices for group vars (#37930)
* demonstrates best practices for group vars

* removes vm-specific var from example

* adds brackets to all [group:vars] refs
2018-04-04 09:50:29 -07:00
scottb
68f81a6799
Reinstated element to fix doc display on mobile devices. (#38246) 2018-04-03 17:13:29 -07:00
Matt Martz
a89d0d0919
Ensure that arguments for sub commands are properly indented (#37992) 2018-04-03 10:56:12 -05:00
Dag Wieers
70d49f7616
Fix indentation issue
<!--- Your description here -->

+label: docsite_pr
2018-04-03 10:45:50 +02:00
Sam Doran
b5b3beff83 Correct syntax highlighting in plugin dev docs (#38184)
Use rst em dash
2018-04-02 15:39:20 -07:00
Daniel
45e4dfda3d doc: fix grammar (#38145) 2018-03-30 18:32:29 +02:00
Alicia Cozine
b72960fdd4
revises network portion of 2.5 porting guide (#37938)
* revises network portion of 2.5 porting guide
2018-03-27 14:59:04 -05:00
Colin Walters
290cca3613 docs/keywords: Clarify async a bit (#37943)
I hastily did a copy/paste of the `async` example and it took me
a while to understand that `async` specified a maximum runtime in seconds.
The docs are actually mostly clear on this, but I made this PR while
reading the code.

This also fixes the spelling of "asynchronously".
2018-03-27 08:15:30 -04:00
Joseph Herlant
00a7ff7974 Move man pages generations to rst2man (#37861) 2018-03-26 16:28:28 -07:00
Matt Martz
ffbbb5a25b
Use arg_spec type for comparisons on default and choices (#37741)
* Use arg_spec type for comparisons on default and choices

* Further improve type casting

* Make sure to capture output in more places

* Individually report invalid choices

* Update ignore.txt after resolving merge conflicts
2018-03-26 12:15:32 -05:00
scottb
3554e2c2d9
Fixes scrolling issue without breaking header nav (#37864) 2018-03-23 17:55:29 -07:00
scottb
47318a50b2
Temporary fix for horizontal scrolling issues on certain pages. Note that this will revert the behavior where headings scroll off the top of the main content region during navigation; fix for that is being investigated. (#37863) 2018-03-23 17:36:56 -07:00
Pilou
56d0721bd9 doc: modules involving file transfert bypass pipelining (#37250)
* doc: modules involving file transfert bypass pipelining

* Fixed typo
2018-03-23 07:02:19 -05:00
Martin Krizek
bcfff1c818 docs: needs_rebase is still used (#37774) 2018-03-23 00:51:53 -07:00
Dag Wieers
69c0f96112 Fix nested parameters in module docs (#37793) 2018-03-22 14:33:51 -07:00
Brian Coca
8b45cab3c1
document our deprecation (#37788)
* document our deprecation

fixes #37779

* Copy edit.
2018-03-22 16:15:02 -04:00
Brian Coca
68e7045a38
try to clarify run_once and forall! (#37754)
* try to clarify run_once and forall!

* fixed hidden tls middle man

* make when note

* Minor edit

* Typo fix
2018-03-22 09:37:14 -04:00
Brian Coca
40a55e9f55 update vars info (#37729)
- remove 1.x references
- update directives to keywords as this is the accepted naming for them
2018-03-22 00:02:45 -07:00
Ryan Pineo
fe87869cec Fix casing on CallbackBase in 2.4 porting guide (#37616) 2018-03-22 00:00:23 -07:00
Brian Coca
06b70f1614 Revert "Add a few Jinja2 tests to simplify template (#37514)"
This reverts commit b8e07f0d6e.
2018-03-20 18:20:43 -04:00
Dag Wieers
b8e07f0d6e
Add a few Jinja2 tests to simplify template (#37514)
Add list test to simplify template
2018-03-20 23:08:55 +01:00
scottb
57da6319e1
Adds VMWare to TOC; sort scenario guides alphabetically (#37661) 2018-03-20 12:15:15 -07:00
Owen Kuemerle
ba4f26313b Correct method to get timedelta seconds value (#37485)
* Correct method to get timedelta seconds value

This also adds additional clarification for extracting different time/date values for time deltas

* Small edit
2018-03-20 12:00:34 -07:00
Brian Coca
64dfaf9cda removed deffered items (#37541) 2018-03-19 01:05:34 -07:00
Michael
7fd74c2089 Fix typo in inventory docs (#37577) 2018-03-19 01:04:29 -07:00
scottb
0a6b951447
Fixes anchors scrolling off the top of the screen during navigation. (#37548) 2018-03-16 21:35:41 -07:00
Arbab Nazar
775e8ed806 fix the typo
<!--- Your description here -->

 label: docsite_pr
2018-03-16 16:26:13 -04:00
Dag Wieers
3cc362d958
Add missing YAML escape characters
These were missing after review PR #37486

 label: docsite_pr
2018-03-15 21:06:16 +01:00
Dag Wieers
e691e07646 Fix boolean input and string-type validation 2018-03-15 12:39:39 -07:00
Abhijeet Kasurde
71e85a45c1 Add missing single quote in inventory_plugin doc (#37403)
Added missing single quote in inventory_plugin doc.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-03-15 01:23:34 -07:00
Robert de Bock
0cf2ecbc62 Update porting_guide_2.5.rst
A fix to a minor typo. ("Previouslu" -> "Previously")

 label: docsite_pr
2018-03-14 17:02:51 -04:00
scottb
381359a8f8
Doc build warning/broken link clean-a-palooza (#37382)
* Doc build warning/broken link clean-a-palooza, WIP commit 1.

* Fixed broken anchor

* Fixing additional broken links; converting from doc to ref.

* Fix anchor
2018-03-14 12:44:21 -07:00
Dag Wieers
80ba7b7402 Various module doc fixes (#37256)
This PR includes:
- A fix for multiple-choice defaults
- A fix for messed up dictionary samples
- Cleaner defaults when they don't appear part of choices
2018-03-12 13:50:52 -07:00
Toshio Kuratomi
fafcb3452f
Porting guide (#37226)
* Add the lookup plugin strictness to the porting guide

* Edited for clarity.

* Wordsmithing.
2018-03-08 16:02:43 -08:00
Dag Wieers
8f2c87231f Ensure the table spans the complete page width (#37129) 2018-03-08 10:48:42 -08:00
Dag Wieers
6636401246 Improve default values and choices in module docs (#36901)
* Improve default values and choices in module docs

So currently we show defaults and choices in separate columns.

For each parameter we have
- Mostly empty default and choices cells
- A list of choices and a separate default value
- Only a default value

So there's a lot of space being wasted on empty cells.
We can do this better.

* Improve Parameters section

* Add Choices back into column header

* Ensure the tables spans the complete page width
2018-03-08 10:48:15 -08:00
Alexander Lex
19f92005b9 Update developing_api.rst (#37108)
Fix for #17716 and #36110
2018-03-08 10:48:48 +00:00
Pierre-Louis Bonicoli
5d410c2c69 doc: 2.3.3 has been released
Sources:
https://github.com/ansible/ansible/releases/tag/v2.3.3.0-1
https://pypi.python.org/pypi/ansible/2.3.3.0
2018-03-07 21:21:56 -05:00
John R Barker
ff28429e2a
Network doc items that are done 2018-03-07 11:37:43 +00:00
Adam Miller
3fd5b0740e allow ANSIBLE_KEEP_REMOTE_FILES for local test runner (#33357)
* allow ANSIBLE_KEEP_REMOTE_FILES for local test runner
* add ANSIBLE_KEEP_REMOTE_FILES to tox.ini, update docs
* Clarify handling of environment variables.
2018-03-06 16:28:06 -08:00
Dag Wieers
eb52a88fb6 Improve module docs return values (#36943)
* Improve module docs return values

Currently the 5 columns shown doesn't make optimal use of the screen
estate, especially for facts modules this is a problem.

* Add returned facts as a separate section

* Remove whitespace and add support section

Since Notes were moved higher up, the Author, Status and Maintainer
information was now placed under the Return Values section.

* Switch Last Updated and Copyright
2018-03-06 10:46:19 +00:00
John R Barker
7a4e270ae0
Link to new network platform pages (#37057)
Also fix a few broken links
2018-03-06 09:32:26 +00:00
Dag Wieers
bcdaba57b5 Remove Sphinx/Read-the-Docs plug on every doc page (#37023)
* Remove Sphinx/Read-the-Docs plug on every doc page

No need to have this on every page.

This fixes #37021

* Reinstated RTD credit with revised wording.

* Re-removed RTD footer boilerplate.
2018-03-05 16:14:27 -08:00
Dag Wieers
cb79957b5f
Make use of named links in documentation notes (#37027)
* Make use of named links in documentation notes

Now that it is possible to name external links, we are making use of
this to make the documentation better.

* Add improvements to ACI documentation

* Disable QA for long line

* Add :menuselection: and :guilabel:

* Improve links on some modules
2018-03-06 00:05:13 +01:00
John R Barker
0a2dda2060
Support <hr/> in module docs (#37030) 2018-03-05 19:18:24 +00:00
John R Barker
985f09270d
Ability to link to other pages from plugin docs (#37009)
Support relative links
2018-03-05 15:16:58 +00:00
scottb
e7f9c5cc60 Copy edits and tweaks 2018-03-02 18:14:07 -05:00
Brian Coca
cf43e0d605 updated api example
- added many more comments
- removed very obsolete 1.x refs
2018-03-02 18:14:07 -05:00
Dag Wieers
6601e78dfa
Wrong syntax 2018-03-01 03:07:03 +01:00
scottb
f923299fe8
Adds the ability to override the doc build output directory from the command line. (#36604)
* Adds the ability to override the doc build output from the command line.

* For safety, removed straight rm of BUILDDIR and removed subdirectories instead.

* Added check to see if BUILDDIR was defined to main makefile
2018-02-28 16:01:18 -08:00
Russ Starr
4a6758b74f Update playbooks_filters_ipaddr.rst (#36883)
Fixed a typo since the example should be referencing the newly defined list.
2018-03-01 09:25:40 +10:00
Alicia Cozine
4f63123320
Network Platform docs (#36814)
* introduces platform docs
2018-02-28 15:16:32 -06:00
Dag Wieers
eae0aa0592 Automatically stuff reference in commit message (#36844)
* Automatically stuff reference in commit message

So we probably want to track which edits were performed through the
Github interface, and this change automatically adds a label to the
commit message.

```yaml
<!--- Your description here -->

+label: docsite_pr
```

Eventually this allows to (on regular basis) list the changes from
documentation readers and process them in a separate process.
2018-02-28 21:14:57 +00:00
Dag Wieers
629278464f Improve contribute-message in document footer (#36841) 2018-02-28 09:21:24 -08:00
Dag Wieers
3b27d723fb Fix indentation of requirements (#36813)
Just discovered that the requirements were indented, whereas all other
lists were not. This makes them stand out for no good reason.
2018-02-28 17:16:18 +00:00
Dag Wieers
38abda544f Improve module docs wrt. required params (#36812)
So I am still not satisfied with how required parameters are being
displayed (before it was yes/no, then it became required/optional, and
only required).

Now it will display in small green 'required' under the parameter name.
This is more convenient, and provides more room for the description.
Especially on smaller screens.
2018-02-28 09:00:56 -08:00
Dag Wieers
974c50a417 Move notes higher up in order (#36815)
So people reading the module documentation usually look for parameters
first, and are interested in examples. However the notes are at the very
end even below the Return Values (the least interesting part).

So this change moves the notes higher up, below parameters, but before
examples so people at least see the notes.
2018-02-28 08:58:49 -08:00
John R Barker
41c066eff9
Fix broken links (#36864) 2018-02-28 15:54:58 +00:00
Daniel Andrei Mincă
8362ddd107 clarify the slicing example (#36842)
As stated by fellow contributors, update the slicing example

Resolves:
Related: #36625
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
2018-02-28 13:28:38 +00:00
John R Barker
3911b9c53a
typo 2018-02-28 12:41:16 +00:00
John R Barker
b3c64ecd09
khjh
j
2018-02-28 12:40:31 +00:00
Antonio Quinonez
de7692b1c9 Explain what the Ansible Quickstart video does (#36453)
* Explain what the Ansible Quickstart video does

Rewrote what video does. The video is really not teaching you how to do the work. It explains why you'd want to use Ansible and shows you what it takes (some sample code) . Video also introduces you to other products in the Ansible ecosystem.

* Edit
2018-02-27 18:40:24 +00:00
Dag Wieers
50e989f906 docs: Workaround for non-string values (#36720)
* Workaround for non-string values

So I think the proper fix should go into html_ify, which should convert
any value into a string, rather than expecting strings only.

* My preferred solution
2018-02-27 18:28:47 +00:00
Wolfgang Felbermeier
9c81b5d92b Fix table display width. (#36728) 2018-02-26 14:24:34 -08:00
Brian Coca
7a81d5f11e removed now irrelevant section
fixes #35760
2018-02-26 14:25:43 -05:00
Matt Clay
3937082892 Fix rst link syntax. 2018-02-26 11:17:43 -08:00
Kevin Breit
487ff1fe9b Fix typos (#36671)
Fix minor typos
2018-02-26 11:24:53 +00:00
Dag Wieers
8f6eea50db
More improvements to ACI module docs (#36689)
* More improvements to ACI module docs

* Asorted improvements

* Found 2 more

* Improvements to aci_rest documentation
2018-02-25 19:13:16 +01:00
Dag Wieers
4ff0317f3e
Improve module doc parameter list (#36688)
This PR includes:
- Indentation of Jinja constructs
- Put parameter name in bold
- Title-case table headers
- Show 'required' when parameter is required (not yes/no)
- Left-align all values
2018-02-25 16:40:27 +01:00
Dag Wieers
97fde8c760
ACI: Asorted fixes to documentation (#36681) 2018-02-24 22:50:54 +01:00
Dag Wieers
7cf08e9986
Improve parameter required values and ref fix (#36680)
This PR includes:
- An improvement to the parameter listing, where instead of yes/no, it
  is indicated with required/optional (easier when scrolling through a
  long list of parameters)
- Ensure that module reference, eg. M(foobar) do not include the module
  document title
2018-02-24 22:36:08 +01:00
Dag Wieers
e520ff2e99
docsite: Improve previous fix for smartphone/tablet (#36678) 2018-02-24 21:45:25 +01:00
Dag Wieers
5da948f792
Fix rendering docsite on smartphone/tablets (#36675) 2018-02-24 17:16:40 +01:00
Dag Wieers
8a040415f9
Fix module references in module docs (#36674) 2018-02-24 17:16:24 +01:00
Dag Wieers
3016bc7351
Asorted docs fixed (#36672)
This PR includes:
- A fix to untemplated {{ plugin_type }} in docs
- Remove the additional info on how to edit module docs (see #36667)
- Add missing delimiter
2018-02-24 14:06:12 +01:00
Dag Wieers
ba370b178d
docsite: Add 'Edit on GitHub' for module docs (#36667)
This is something I always wanted, a 'Edit on GitHub' button for module
documentation.

I also removed the additional statement in the footer with instructions
on how to edit the module documentation.

PS The links go directly into the GitHub file editor now !
2018-02-24 03:57:37 +01:00
Dag Wieers
fde4cc6219
guide_aci: Fix a few references (#36666) 2018-02-24 01:47:44 +01:00
Brian Ong
1abc47c5d3 Fixed indentation error in facts-demo.yml example. (#36645)
* Fixed indentation error in `facts-demo.yml` example.

`content` and `dest` should be indented under the `copy` module.

* Updated indentation of copy module in `facts-demo.yml` example.

Updated indentation of copy module in `facts-demo.yml` to be inline with its name.
2018-02-24 00:38:50 +01:00
Dag Wieers
7da7ba79bc Add anchors to some guides and all module categories (#36642)
* Add anchors to some guides and all module categories

This is required if we want to use *absolute* :ref: references instead of *relative* :doc: references.

* Update the Cisco ACI Guide reference

* Add `aci_guide` anchor

* Add `network_guide` anchor

* Add category anchor

* Improve readability

* Fix small typo
2018-02-23 17:10:47 -06:00
Matt Martz
076ea07bb5
Add instructions for creating backport PRs (#36593)
* Add instructions for creating backport PRs

* Update development_process.rst

simpler workflow

* Update development_process.rst

added origin note

* A few adjustments to clarity, use backport instead of cherry pick in branch name

* Address formatting issue

* fetch isn't a flag

* Fix rst formatting
2018-02-23 09:51:36 -06:00
Daniel Andrei Mincă
62f237f21e fix erroneous example in inventory (#36625)
After initializing a list in both Python2/Python3 with below elements,
I've tested the indexing and realised that the examples provided in the
documentation are erroneous.

As a result, update the examples with correct values in order to avoid
any future confusion.

Resolves:
Related:
Signed-off-by: Daniel Andrei Minca <mandrei17@gmail.com>
2018-02-23 10:46:31 +00:00
Alicia Cozine
51a010a696 Network Getting started docs (#36337)
* first draft of getting started guide
2018-02-22 20:43:04 +00:00
Dag Wieers
7435e115e0
ACI: Various changes to module documentation and guide (#36516)
* ACI: Various changes to module documentation and guide

This PR includes:
- We moved the object class information to the notes
- Add version information to guide chapters
- Add generic note to modules with reference to ACI guide
- Reference known issues in aci_rest documentation
- Remove module_utils function docs from modules
- Indicate which parameters are not required for querying all objects
- Added missing RETURN information

* Fix copyright strings

* Remove aci_domain_to_encap_pool.py for v2.5

* More updates

* PEP8 fix

* Improve listings of parameters/return values
2018-02-21 19:35:59 +01:00
Klaas Demter
ce80485ecd [Doc] Update Conditional Imports (#35492)
* [Doc] Update Conditional Imports

facter/ohai is not needed for the ansible internal facts
also fix that os_family for centos is redhat

* Copy edit.
2018-02-20 12:12:12 -08:00
Matt Lee
75ab070c63 Update vault.rst (#36328)
hunter2 not hunter42. http://bash.org/?244321
2018-02-20 12:11:32 -08:00
Ganesh Nalawade
b57cc7cf31
Update network debug troubleshooting guide (#36288)
* Update network debug troubleshooting guide

Fix #35914

Command timeout and connection timeout error messages
are dsiplayed in log file instead on console.
Update the same in troubleshooting guide.

* Update example error

* Fix CI issues

* Fix more CI failures

* More fixes

* Fix review comments

* Fix more review comments

* Copy edit
2018-02-19 20:40:25 +05:30
Dag Wieers
79d00adc52
aci_rest: Fix error handling and improve documentation (#36295)
This PR includes:
- A fix for a recently introduced issue wrt. error handling
- Added integration tests for provoked errors
- Influence standard return values using aci library for aci_rest
- Add proxy support documentation
- Documentation update related to #34175
2018-02-19 12:01:14 +01:00
John R Barker
f77a390131
Depreciate aos (#36029)
* Deprecate Apstra's aos_* modules

These modules don't work with AOS 2.1 or higher.
They will be replaced non-upstreamed modules

* Correct list
2018-02-16 18:26:07 +00:00
Brian Coca
3eff279dd7 updates to module testing (#36043)
* updates to module testing

gives those using internal modules an alternative

* Copy edit
2018-02-16 10:04:10 -08:00
Brian Coca
1f363a6a7c updates to porting guide (#36219)
* updates to porting guide

(cherry picked from commit 7a6d6870d4633ae38a14cc799521b5fc1c0320fd)

* Edits to correct spelling, grammar, and clarify wording.

* Fixed typo
2018-02-15 23:54:45 -08:00
Matt Martz
50adc5409b Add several new doc<->arg_spec checks (#36247)
* Add several new doc<->arg_spec checks. See #18183

* Update ignore.txt for validate-modules
2018-02-15 20:34:40 +00:00
John R Barker
577ff4d949
Add stub porting_guide_2.6.rst (#36190)
* Add stub porting_guide_2.6.rst

* Typo fix
2018-02-15 07:29:15 +00:00
scottb
1f609f8be3
Cleaned up some scenario guide titles and TOC placement. (#36225) 2018-02-14 23:14:22 -08:00
scottb
391896ca9d
Fixed typo in link. (#36220) 2018-02-14 18:37:03 -08:00
David Newswanger
3f5caf659e added support for --testcase flag in ansible-test (#36134)
* added support for --testcase flag in ansible-test

* fixed command format

* added tab completion

* fixed sanity issues

* added documenation for --testcase

* don't autocomplete when multiple modules are selected
2018-02-14 15:40:35 -08:00
Brian Coca
0cf70a8970
never tags docs and test (#35964)
* fufilling the promise

* moved changes

* Copy edit
2018-02-14 17:01:36 -05:00
scottb
c5dd0d97af
Relocate ACI guide and add to TOC (#36208) 2018-02-14 14:00:18 -08:00
scottb
dc902a5022
Fixes broken nested tables in module docs (#36144) 2018-02-13 15:21:10 -08:00
Brian Coca
28015d8ae9 ensure cli dir exists before saving files to it 2018-02-13 17:43:26 -05:00
Brian Coca
5a0f4f0646 removed gnerated files
@dharmabumstead, probably need a few more of these
2018-02-13 15:47:31 -05:00
Patrick Fink
43eb97ef92 Fix typo in vars.rst (#35098) 2018-02-13 15:05:11 -05:00
scottb
c10080bfba
Followup to docs refactor pull request #36067 - fixes gitignore and c… (#36120)
* Followup to docs refactor pull request #36067 - fixes gitignore and cleanup in makefile; removes some generated files; moves a straggler to the appropriate subdirectory.

* Fixed some stragglers

* Removed redundant module entries

* Delete generated RST files.
2018-02-13 10:52:13 -08:00
scottb
373b1dcf59
Core Docs Refactor and Redesign (#36067)
* Docs refactor as outlined in https://github.com/ansible/proposals/issues/79. Moves content into 'guides'; refactors TOC; fixes CSS; design tweaks to layout and CSS; fixes generated plugin, CLI and module docs to fix links accodingly; more.

* Adding extra blank line for shippable
2018-02-13 07:23:55 -08:00
John R Barker
480a9c10c9
Consistant headings (#36112) 2018-02-13 14:43:16 +00:00
Dag Wieers
a875363e35
ACI docs: Add more links to resources and community (#36101)
This PR includes:
- Adding more resources to each section
- Improving wordings
- Add links to the Ansible ACI community pages
2018-02-13 13:54:44 +01:00
Dag Wieers
218f008dab
ACI docs: Add a section about common error messages (#36088)
Since we pass information directly to ACI, we sometimes get error messages back to the user that require some additional information or context.

This PR includes:
- Changes to the default error output so the error is easier to find
  when searching in e.g. Google
- 3 specific error messages that we have encountered and has confused
  our users before
2018-02-13 03:13:08 +01:00
Matt Davis
5f68892e81
requested status updates/removals of punted items 2018-02-12 10:37:04 -08:00
Rvgate
d5ae63c0ea Change wording of Going Further section (#35949)
* Change wording of Going Further section

The original wording was confusing with its non-devel branch part.
Made it much clearer for people to understand what to do.

Also removed the git command for creating branches, I believe a
develop should be aware of how basic git commands work.

* Edited for concision and clarity.

* Typo fix

* Typo fix
2018-02-11 00:32:22 -08:00
John R Barker
c3523cdd60
Test against a single transport (#35903)
Network integration tests can use tags to run only a specific transport
2018-02-09 16:07:41 +00:00
Dag Wieers
80e1e0b017
ACI: Assorted set of fixes to docs (#35780)
* Assorted set of fixes

* Cosmetic changes to lists

* Add more information related to connection throttling

* Changes to TOC

* Document return values

* More improvements

* Fix casing in title
2018-02-09 17:03:39 +01:00
tterranigma
3371a93b9e Adds doc for new slice filter (#35904)
* Adds doc for new slice filter

* Fixes example

* Adds empty line

* Moves documentation to other section and removes bad suggestion
2018-02-08 12:41:25 -05:00
Brian Coca
07221d777a
Better document connection: local (#34462)
* Better document connection: local

* Attempt at clear wording.

* Fixed spacing
2018-02-07 16:17:57 -05:00
Brian Coca
297eab5073 move away from bad inline var defs
partial fix for #35714
2018-02-07 16:17:01 -05:00
Martin Krizek
4319947e60
Remove jinja native types from roadmap (#35444) 2018-02-07 17:00:16 +01:00
Ganesh Nalawade
1d068d4af9 Update network section in 2.5 porting guide (#35643)
* Update 2.5 porting guide with network module_utils move
2018-02-06 15:35:59 -06:00
Dag Wieers
67c217398c
Add initial ACI guide (#35364)
* Add initial ACI guide

* Implement all review suggestions
2018-02-06 11:44:32 +01:00
Marc Mercer
6bd4803c80 Fixing syntax for mail callback doc (#35379) 2018-02-05 23:14:08 -08:00
Andrew Gaffney
e9b0a4ccb4 Add support for defining index var for task loops 2018-02-05 22:14:05 -05:00
Sam Doran
636ef65099 Fix panos_object docs so they generate properly (#35756)
Change description field to a list rather than folder scalar.

Cleanup formatting and line breaks in README.
2018-02-05 18:49:02 -07:00
Joshua Smith
cee5d420de Add examples for OpenBSD hosts. (#35691)
* Add examples for OpenBSD hosts.

* Incorporate changes recommended based on feedback from my pull request.
2018-02-05 18:21:45 -05:00
Tina Müller (tinita)
57d5b8642a Add examples to YAMLSyntax; fix minor issues and improve wording (#35703)
* Add examples to YAMLSyntax; fix minor issues and improve wording

I added proper titles to "Flow Collections" and "Block Scalars", because these
are official YAML Terms, so people can find better help when having issues.

I changed the "ignored newlines" to "folded newlines" because I think ignoring
gives a wrong impression, especially since empty lines (more than one newline)
are not ignored and have a special meaning.

I added an example how to enforce a newline in a folded block scalar.

I fixed the list of characters that are allowed/not allowed in plain and
double quoted scalars.

I added the #yaml channel to the IRC link.

I added links to the YAML Specs. For completeness, I also included YAML 1.2,
although PyYAML and libyaml currently implement 1.1.

* Improve wording

* Add three more characters to forbidden first characters
2018-02-05 13:32:06 -08:00
Matt Martz
975f4def78
Tags on includes only affect the include. FIxes #35729 (#35732) 2018-02-05 09:53:56 -06:00
Joshua Smith
5c2783c161 Update example syntax in playbooks_tests.rst. (#35688) 2018-02-05 14:14:15 +00:00
Joshua Smith
f1d0279921 Update example syntax in test_strategies.rst, (#35689) 2018-02-05 14:13:00 +00:00
Ivan Bojer
196f2f382b removed panos_nat_policy (#34432)
* removed panos_nat_policy

* merge

* removed extra line
2018-02-03 11:35:17 +00:00
Joshua Smith
e1c9c6eded Update example syntax in playbooks_tags.rst. (#35680) 2018-02-03 11:33:02 +00:00
Joshua Smith
060890f3b2 Update example syntax in playbooks_loops.rst. (#35679) 2018-02-03 11:32:11 +00:00
Joshua Smith
aeb749e116 Update example syntax in playbooks_lookups.rst. (#35678) 2018-02-03 11:31:12 +00:00
Joshua Smith
1b7e5d19a2 Update example syntax in playbooks_intro.rst. (#35677) 2018-02-03 11:30:54 +00:00
Joshua Smith
0a5ff792e4 Update example syntax in playbooks_filters.rst. (#35676) 2018-02-03 11:30:24 +00:00
Joshua Smith
6179bd378c Update example syntax in playbooks_error_handling.rst. (#35675) 2018-02-03 11:29:58 +00:00
Joshua Smith
3fe6de475b Update example syntax in playbooks_delegation.rst. (#35674) 2018-02-03 11:29:40 +00:00
Joshua Smith
203c8f4334 Update example syntax in playbooks_conditionals.rst (#35673) 2018-02-03 11:29:22 +00:00
Joshua Smith
6c1a63dd14 Update example syntax (#35670)
* Update examples in guide_rolling_upgrade.rst.

* Update examples playbooks_best_practices.rst.

* Update examples in playbooks_checkmode.rst.
2018-02-03 11:28:22 +00:00
Joshua Smith
7b76da2d4c Update some examples to use proper YAML syntax. (#35640)
* Update some examples to use proper YAML syntax.

* Make the requested changes so this builds properly.

Also fix emphasis line numbers to match what was being emphasized before
the change.
2018-02-02 18:20:03 +00:00
Abhijeet Kasurde
d7d9e40dd1
VMware: Deprecate vsphere_guest module (#35648)
This change deprecates vsphere_guest in favor of vmware_guest and other
related modules.

The major reasons behind deprecation are -

- Pysphere - Unofficial Python bindings of vCenter deprecated in the year 2013.
- VMware provides official Python bindings for vCenter, which is used in vmware_guest.
- vcsim - simulator used in integration testing of vmware module does not support PySphere
  APIs, which makes it more difficult to test vsphere_guest.

Please see [deprecation plan](https://github.com/ansible/community/wiki/VMware%3A-vsphere_guest_deprecation)

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-02-02 20:03:57 +05:30
jctanner
4ec16867fd Fix loop/with typo in loops doc (#35652) 2018-02-02 13:33:13 +00:00
René Moser
785e888ea0 doc: fix loop examples (#34991) 2018-02-02 13:52:28 +01:00
Ivan Bojer
9ddf8b8ee5 remove panos_security_policy (#34433)
* remove panos_security_policy

* added depreciation notice

* - deprecation notice

* properly document deprecated module

* merge changes

* merge changes

* parser expects srt for deprecations attributes
2018-02-02 12:35:02 +00:00
Mike Cavedon
e59d3dd524 Update playbooks_best_practices.rst (#35627)
* Update playbooks_best_practices.rst

If deploying to the first 10 hosts in Boston it should be "-limit boston[0:9]" and the next 10 should be "-limit boston[10:19]". The doc as written would skip the first host (boston[0]) and try to deploy to a host that doesn't exist (boston[20])

* Typo fix
2018-02-02 12:21:21 +00:00
Joshua Smith
0c012703c1 Update developing inventory script docs. (#35639)
* Update developing inventory script docs.

* Copy edit.
2018-02-02 02:03:17 -08:00
Alicia Cozine
adf76b7d3f
Reflect new process for network integration tests (#35577)
With `ansible-test network-integration` we don't need the top level yaml files
except NXOS and Dell (for now)
2018-01-31 14:56:28 -06:00
Toshio Kuratomi
0b4debad53 Update the release doc with ansible-2.4.3 2018-01-31 12:30:11 -08:00
Alicia Cozine
9dad5d6b7f creates structure for network docs (#35514) 2018-01-31 10:01:55 -08:00
Abhijeet Kasurde
9d3ba7e36a VMware: Add basic vmware module related guide (#35128)
* VMware: Add basic vmware module related guide

This fix adds page tries to consolidate various information related
to vmware modules and debugging related information.

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>

* Copy edits

* Added module reference

* Edits

* Fixing invalid characters
2018-01-31 09:57:05 -08:00
John R Barker
06734f27c6
Network Doc status (#35475)
Plus remove trailing whitespace
2018-01-31 09:04:06 +00:00
Kylie Liang
e497509e51 Update guide_azure.rst to include note about running ansible from within azure (#35441)
* Update guide_azure.rst

Add one more option to run Ansible in Azure

* Minor edit
2018-01-30 17:31:10 -08:00
Matt Martz
3729cc57d0
Add porting guide note about include inheritance change (#35199)
* Add porting guide note about include inheritance change. Fixes #35096

* Also make note of using import_* when possible

* Edited for clarity.
2018-01-30 09:09:41 -06:00
John R Barker
a23c95023b
Module deprecation: docs, scheme and tests (#34100)
Enforce module deprecation.
After module has reached the end of it's deprecation cycle we will replace it with a docs stub.

* Replace deprecated modules with docs-only sub
* Use of deprecated past deprecation cycle gives meaningful message (see examples below)
* Enforce documentation.deprecation dict via `schema.py`
* Update `ansible-doc` and web docs to display documentation.deprecation
* Document that structure in `dev_guide`
* Ensure that all modules starting with `_` have a `deprecation:` block
* Ensure `deprecation:` block is only used on modules that start with `_`
* `removed_in` A string which represents when this module needs **deleting**
* CHANGELOG.md and porting_guide_2.5.rst list removed modules as well as alternatives
* CHANGELOG.md links to porting guide index

To ensure that meaningful messages are given to the user if they try to use a module at the end of it's deprecation cycle we enforce the module to contain:
```python
if __name__ == '__main__':
    removed_module()
```
2018-01-30 12:23:52 +00:00
Jordan Borean
4da19f2d6b Added code-smell check to verify filenames are allowed with Windows (#35436) 2018-01-29 13:46:02 -08:00
Alessandro Pilotti
1baa9b4d90 Use TEMP variable instead of hardcoded path (#35380)
The script fails if a Temp directory is not present in the system drive (e.g. C:\Temp).
This can be solved by using the TEMP environment variable instead.
2018-01-29 11:47:06 +10:00
Anton Ovchinnikov
afc4d3c203 Small documentation fix in vault.rst (#35384) 2018-01-26 13:06:40 -08:00
Dag Wieers
1719267779 Sort arguments and return values in module docs
Comparing the old module docs, with the devel docs the
options/arguments/parameters are no longer sorted.

Also, both in the old module docs and the devel docs the result values
are not sorted where they probably should.
2018-01-25 18:34:27 -08:00
Dag Wieers
73f3b36fb1
Fix modules index delimiter and improve readability (#35187)
* Fix modules index delimiter and improve readability

* Hopefully fixes the links correctly :-/

* Anoteher attempt at this madness
2018-01-25 23:28:57 +01:00
John R Barker
3fadc5d614 Formatting and broken links (#35226) 2018-01-25 13:06:03 -08:00
Matt Clay
7abdab6c9e Convert ansible-test compile into a sanity test. 2018-01-25 09:45:36 -08:00
Matt Clay
e0010f15e4 Add pslint sanity test. (#35303)
* Add pslint sanity test.

* Fix `no-smart-quotes` sanity test.

* Add docs for `pslint` sanity test.
2018-01-24 17:22:14 -08:00
John R Barker
181085821b
Clarify when and how to enable ANSIBLE_DEBUG (#35220) 2018-01-23 17:10:17 +00:00
Trishna Guha
ba9b5ca048
doc update (#35214)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-01-23 09:51:11 +05:30
Abhijeet Kasurde
c0df05c028
github_release: Fix state returned from module (#33735)
This fix corrects the module state returned by github_module.
Now,
* When the release already exists, state is "ok"
* When the release is created, state is "changed"

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-01-23 08:37:41 +05:30
Kedar Kekan
5c2f3e3b8c
Update ROADMAP_2_5.rst 2018-01-23 07:09:20 +05:30
Toshio Kuratomi
f94fe61b6b Documentation and changelog for the plugin_filtering config option 2018-01-22 17:13:41 -08:00
Aidan Feldman
de60328d94 add documentation around commonly-used Facts for Conditionals (#34263)
* add documentation around commonly-used Facts for Conditionals

There are a few Facts that are often used for Conditionals, so
documenting them on the Conditionals page with their possible values.

* Edit
2018-01-22 13:37:19 -08:00
Jordan Borean
d0e6889f93 win_become: another option to support become flags for runas (#34551)
* win_become: another option to support become flags for runas

* removed uneeded entries

* fixed up whitespace issue

* Copy edit
2018-01-19 13:58:10 -08:00
Matt Martz
3c400c5899
ANSIBLE_METADATA doesn't support YAML currently, change 315 to invalid data type (#35009) 2018-01-17 14:15:22 -06:00
Matt Martz
a352d43824
Compare arg+aliases between docs and argument_spec (#34809)
* compare arg+aliases between docs and argument_spec

* Add some special handling for the network modules provider options that also appear in the top level arg spec

* Fix error code for bigip_hostname

* Address merge conflicts due to changes in f5 modules

* Update validate-modules ignore based off a clean execution

* Address merge conflicts

* Address renamed module

* Address recent changes to modules

* Add ignore for ucs_ip_pool

* Update aci modules to get more reliable documentation comparison, but not mutating the module_utils aci_argument_spec

* Update ignore.txt after recent aci updates

* Add extra guard to ensure we handle provider special only for network modules

* Address additional changes to modules
2018-01-17 10:11:30 -06:00
Nigel Rahkola
2a6156a9d8 Fix syntax error in intro_inventory yaml example (#34960) 2018-01-16 15:41:17 -06:00
Matt Davis
9cf217a151
allow cert validation to be disabled for Azure modules (#34906)
* `validate` or `ignore` values may be set by module, credential profile, or env. Module has highest precedence, followed by credential profile, then environment, and defaults to `validate` if not otherwise specified.
* fixes #33455
2018-01-16 10:14:08 -08:00
Alexander Lex
59042d79f5 Update developing_api.rst to use correct inventory format for single explicit host (#34919)
Fix for #34918
2018-01-16 09:57:11 -06:00
Brian Coca
bbd6b8bb42 Temporary (#31677)
* allow shells to have per host options, remote_tmp

added language to shell
removed module lang setting from general as  plugins have it now
use get to avoid bad powershell plugin
more resilient tmp discovery, fall back to `pwd`
add shell to docs
fixed options for when frags are only options
added shell set ops in t_e and fixed option frags
normalize tmp dir usag4e

- pass tmpdir/tmp/temp options as env var to commands, making it default for tempfile
- adjusted ansiballz tmpdir
- default local tempfile usage to the configured local tmp
- set env temp in action

add options to powershell
shift temporary to internal envvar/params
ensure tempdir is set if we pass var
ensure basic and url use expected tempdir
ensure localhost uses local tmp
give /var/tmp priority, less perms issues
more consistent tempfile mgmt for ansiballz
made async_dir configurable
better action handling, allow for finally rm tmp
fixed tmp issue and no more tempdir in ballz
hostvarize world readable and admin users
always set shell tempdir
added comment to discourage use of exception/flow control

* Mostly revert expand_user as it's not quite working.

This was an additional feature anyhow.

Kept the use of pwd as a fallback but moved it to a second ssh
connection.  This is not optimal but getting that to work in a single
ssh connection was part of the problem holding this up.

(cherry picked from commit 395b714120522f15e4c90a346f5e8e8d79213aca)

* fixed script and other action plugins

ensure tmpdir deletion
allow for connections that don't support new options (legacy, 3rd party)
fixed tests
2018-01-15 21:15:04 -08:00
Matt Martz
ae49dd65d9 Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance (#34769)
* Add note to 2.4 porting guide about initial playbook relative host/group_vars and inheritance
2018-01-15 10:00:59 -08:00
jctanner
b10d5f34ea Extend validate-modules to check the next to last line (#34819)
* Add validation for the next to last line of a module

* Fix last error code

* Reduce to a single conditional

* Fix conditionals

* Move the final warnings statement to main() in mysql_replication
2018-01-15 15:49:35 +00:00
Matt Martz
86e4619dcf
Update echo ansible-vault example with -n as without this, you get a newline. Fixes #34795 (#34823) 2018-01-12 16:16:37 -06:00
Matt Martz
dcc05093db Validate modules arg spec fixes (#34477)
* Update validate-modules arg_spec introspection to be faster, by only mocking the imports we explicitly list
* The use of types.MethodType in redhat_subscription wasn't py3 compatible, use partial instead
* Remove argument_spec import hacks, make them errors, we can ignore them with ansible-test
* Enable the --arg-spec flag for validate-modules
2018-01-11 15:41:53 -08:00
Samer Deeb
f8884f12bc Mellanox OS name change: MLNXOS changed to ONYX (#34753)
* Mellanox OS name change: MLNXOS changed to ONYX

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Fix alphabetical order of modules metadata

Signed-off-by: Samer Deeb <samerd@mellanox.com>
2018-01-11 22:21:17 +00:00
Ricardo Carrillo Cruz
e9d62e18c7 Mark cliconf refactor on 2.5 roadmap as done (#34735) 2018-01-11 12:44:47 +00:00
Pilou
b66863abf0 dev_guide: don't ask to use '© Ansible Project' (#34704)
contributor don't sign any copyright assignment, then this makes no
sense.
2018-01-11 14:23:36 +10:00
Nathaniel Case
caf1b357aa
Update ROADMAP_2_5.rst
Mark connection-related tasks as done
2018-01-10 10:00:32 -05:00
Matt Martz
d1846425db
Provide a way to explicitly invoke the debugger (#34006)
* Provide a way to explicitly invoke the debugger with in the debug strategy

* Merge the debugger strategy into StrategyBase

* Fix some logic, pin to a single result

* Make redo also continue

* Make sure that if the debug closure doesn't need to process the result, that we still return it

* Fix failing tests for the strategy

* Clean up messages from debugger and exit code to match bin/ansible

* Move the FieldAttribute higher, to apply at different levels

* make debugger a string, expand logic

* Better host state rollbacks

* More explicit debugger prompt

* ENABLE_TASK_DEBUGGER should be boolean, and better docs

* No bare except, add pprint, alias h, vars to task_vars

* _validate_debugger can ignore non-string, that can be caught later

* Address issue if there were no previous tasks/state, and use the correct key

* Update docs for changes to the debugger

* Guard against a stat going negative through use of decrement

* Add a few notes about using the debugger on the free strategy

* Add changelog entry for task debugger

* Add a few versionadded indicators and a note about vars -> task_vars
2018-01-09 13:50:07 -06:00
osLEccse
9c7d987395 Update developing_api.rst (#34629)
Module path needs to be array instead of a string variable in order to work.
2018-01-09 11:23:01 +00:00
Lars Kellogg-Stedman
29fbf0c756 remove erroneous '.' in docsite footer (#34592)
This removes an erroneous '.' in the docsite that someone pointed out
on irc.
2018-01-08 22:36:47 -08:00
Cedric Pimenta
cd1b144c0a Improve documentation about Comment filter (#34539)
Include a mention to the decoration option, which allows someone to
specify the character comment to be used.
2018-01-08 15:07:32 -08:00
Adam Miller
a67e922a40 fix ansible-galaxy requirements.yml import_tasks->include in docs (#34519)
Signed-off-by: Adam Miller <admiller@redhat.com>
2018-01-08 16:18:40 -06:00
John R Barker
42dd48a6d0
Update done Network 2018-01-08 15:21:43 +00:00
John R Barker
1e292c0211
Correct broken link to playbooks_tests 2018-01-08 12:28:48 +00:00
Yuji Konishi
2039366380 typo (#34549) 2018-01-07 20:31:06 +01:00
John R Barker
1826c27e68
All 2.5 release dates to be pushed out by one week (#34456) 2018-01-05 13:19:48 +00:00
Trishna Guha
9d2182bcf8 Deprecate nxos_switchport and Add nxos_l2_interface DI module (#33813)
* Deprecate nxos_switchport

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l2_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* aggregate test for nxos_l2_interface

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* revert nxos_switchport test change

* gundalow's comment

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2018-01-05 07:44:02 +00:00
Jordan Borean
a830cae160
windows become - info about blank passwords (#34331)
* windows become - info about blank passwords

* Edited for clarity
2018-01-05 06:00:08 +10:00
Abhijeet Kasurde
f58d9da703 Update link in common footer (#34397)
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2018-01-03 20:52:14 -08:00
Tomáš Karásek
ec7b412193 Fix Packet guide to comply with latest version of the packet module (#31410)
* Fix Packet guide to comply with latest version of the packet module

* Fix backticks in rst

* rephrase wait_for_public_IPv description

* Edited for clarity.
2018-01-03 19:05:04 -08:00
Jordan Borean
278663ad2c
windows: updated docs to include info regarding https validation (#34128)
* updated docs to include info regarding https validation

* some doc edits
2018-01-04 08:47:37 +10:00
Jordan Borean
57ed6a866f windows: Add IPv6 address support and docs to go with it (#34072)
* windows: Add IPv6 address support and docs to go with it

* minor docs fix

* fixed some doc sentances
2018-01-03 09:26:53 -08:00
John R Barker
43b0ba0679 Docs network best 2.5 (#33544)
* Best practices for Ansible 2.5 networking

* How to use network_cli
* How to pass credentials

* Proxy

* rename facts-demo.yml + tree

* code-block formatting

* Move platform specific notes to new page (PR pending)

* use ansible_network_os rather than group_names

* Scott's comments

* Update network_best_practices_2.5.rst
2018-01-03 05:44:55 -05:00
Pilou
6a6f5129a9 dev_guide: fix a slip (#34143)
replace 'Formatting options' with 'Formatting functions'
2017-12-26 10:18:09 +00:00
Matt Martz
57575d1cfa
Fix tests as filters #4 (#33930)
* Resolve newly added tests as filters

* Add code smell to test for ansible provided jinja tests as filters syntax

* Add docs for no-tests-as-filters code smell test

* Address tests as filters in new integration tests

* Address feedback

* Address feedback 2
2017-12-21 13:42:53 -06:00
Toshio Kuratomi
94d952f94b
Documentation on how to make a release. (#31426)
* Release Engineering Docs with pointer to the Docs on how to actually make the release.
2017-12-21 08:14:49 -08:00
scottb
f8f34c7bab
Moved generated module RSTs to their own directory. (#33966)
* Moved generated module RSTs to their own directory.

* WIP commit - fixed conflict with conf.py exclude_patterns by renaming module RST output directory to 'module_docs'.

* Added new directory to formatter module links; aded new module directory to makefile clean.

* Removed illegal comment from block.
2017-12-21 01:47:39 -08:00
John R Barker
c50da48049
Fix various RST warnings (#34084)
* Fix various RST warnings

* shorter lines
2017-12-20 15:20:05 +00:00
John R Barker
7381554e42 Compact documentation (#34081)
Before this fix lists of `documentation:` were in individual <p> tags
causing a lot of whitespace on the rendered _module.html pages.
2017-12-20 20:49:09 +10:00
Jordan Borean
0880297909 fix options output for bool type (#34074) 2017-12-20 09:48:17 +00:00
Trishna Guha
be89822bb5
Deprecate nxos_portchannel and add nxos_linkagg DI module (#33376)
* deprecate nxos_portchannel

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_linkagg DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* remove nxos_portchannel unit test

* fix syntax issues

* fix ansible-doc failure

* update nxos_portchannel unittest

* minor fixes and integration test

* update nxos_linkagg
2017-12-20 11:26:07 +05:30
Trishna Guha
3cce8dfafd
Deprecate nxos_ip_interface and Add nxos_l3_interface DI module (#33866)
* Deprecate nxos_ip_interface module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add nxos_l3_interface DI module

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* Add integration test

Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>

* pep8 fixes

* Add nxapi cli test

* Improve complexity

* manage layer3 interface

* fix unit test
2017-12-20 11:07:23 +05:30
aaron jheng
378636078a use print function (#34013) 2017-12-19 09:31:30 -06:00
Martin Krizek
35c6b17a14 playbook_loops.rst: fix formatting (#34026) 2017-12-19 11:26:05 +00:00
Jordan Borean
a2810f44a8 Fixed up windows command quoting example 2017-12-18 06:26:04 +10:00
Will Thames
5f29cd5e60 Add validation test for new copyright (#32919)
* Update validation test for new copyright

Ensure new modules without the new copyright header fail
validation
Ensure existing modules without copyright in top 20 lines fail

* Add documentation of 108 error

Create label in developing modules documentation so that
the validation page can point to it

* Ensure new style copyright header passes test!
2017-12-16 09:23:54 -08:00
Micah Abbott
2f2f118665 python_3_support.rst: fix broken links (#33951)
The links pointing to 'Building From Source' and 'Inventory' were not
valid, so I updated them to point to locations that seemed
appropriate.

Signed-off-by: Micah Abbott <miabbott@redhat.com>
2017-12-15 20:04:53 +00:00
Brian Coca
2b7799f817
added flatten filter (#33102)
* added flatten filter
2017-12-15 14:40:02 -05:00
John R Barker
f127e5d535
Fix a few docs build issues (#33685)
Noticed when doing `make webdocs`
2017-12-14 17:33:27 +00:00
Sam Doran
bf29cc79a6 Further clarify what determines batch size in a play (#33833) 2017-12-13 10:38:30 -06:00
Jordan Borean
07e9df11b3
windows dev docs - vagrant info (#33515)
* windows dev docs - vagrant info

* added info about FileUtil and LinkUtil

* Initial edit pass - WIP

* updated some wording

* fix some more general sayings to be more professional
2017-12-12 08:16:22 +10:00
John R Barker
33c7a157ab
Create network_working_with_command_output.rst (#33709)
Move this content to new location prior to intro_networking.rst refactor
2017-12-11 13:22:58 +00:00
Pilou
326b208b19 osx_say: add espeak support, rename module to say (#33071)
* Rename osx_say module into say

* say: remove undocumented default value for voice parameter

* say: add support for espeak command

* say: handle check_mode

* say: handle GNUstep tool
2017-12-09 13:45:31 +00:00
Sam Doran
b55cc61ef0 Clarify docs to explain that max_fail_percentage uses batch size (#33720) 2017-12-08 12:09:38 -05:00
Matt Martz
2d2f288e77
Add docs describing some additional behaviors around modules (#33631)
* Add docs describing some additional behaviors around modules, to outline why generic modules will not be accepted

* Add/copy the generic module guidelines to developing_modules

* Edits for clarity

* Edits for clarity
2017-12-07 15:31:26 -05:00
John R Barker
c2bef76c46
Various doc formatting fixes (#33626)
* Avoid italics from `with_`
* C() is for Modules, not for RST
* RST uses ``...`` for code
2017-12-07 14:25:46 +00:00
Matt Martz
349099a4c6
Fix sorting in man template on python3. Fixes #33663 (#33673) 2017-12-07 09:16:04 -05:00
John R Barker
f4cc3fb56d
Remove fixme coment 2017-12-07 10:34:10 +00:00
John R Barker
e4a465b6e8
Docs: Network become for privilege mode (#33367)
* Network become for privilege mode

* Document what privilege mode is
* How to tell if you need it
* How to enable
* Tidy up formatting on page
* authorize & auth_pass
* network group_vars.
2017-12-07 10:27:43 +00:00
Renato Piccoli
794c5a6e53 A small typo (RFX->RFC) in vault.rst (#33553)
Correction for a typo in vault.rst.
2017-12-06 08:42:59 +05:30
Matt Clay
90ac38bd4c Fix module validator handling of empty options. 2017-12-05 16:46:05 -08:00
David Chkhikvadze
84ace7acc3 Add missing be (#33507) 2017-12-04 13:21:54 +01:00
Ganesh Nalawade
11c9ad23d5
Refactor common network shared and platform utils code into package (#33452)
* Refactor common network shared and platform specific code into package (part-1)

As per proposal #76 refactor common network shared and platform specific
code into sub-package.
https://github.com/ansible/proposals/issues/76

*  ansible.module_utils.network.common - command shared functions
*  ansible.module_utils.network.{{ platform }} - where platform is platform specific shared functions

*  Fix review comments

* Fix review comments
2017-12-03 21:42:30 +05:30
Nathaniel Case
7f90c9d1a7
Warn on provider with network_cli (#33355)
* Warn on `provider` with network_cli

also unify action plugins

* Add to porting guide about connection warnings
2017-12-01 12:22:54 -05:00
Zbigniew Jędrzejewski-Szmek
4c29396217 Add dnf and yum commands in "Installation" section (#33369)
* Add dnf and yum commands in "Installation" section

Even though the command is very simple, it's good to be able to c&p it.
There were already commands for apt, emerge, pip, even direct installation
from git, so adding Fedora/RHEL/CentOS examples is reasonable.

Since yum is not installed by default on any supported Fedora releases
(F26 and F28 currently), recommend dnf.

* Tiny edit
2017-12-01 02:19:08 -08:00
Toshio Kuratomi
7bd0af15d2
Enhance empty __init__ code-smell to check module_utils (#33438)
Empty __init__ will allow us to use python namespaces with all of these
files.  That may be something we want to take advantage of for allowign
them to be expanded by user dirs.  Also might be needed for AnsiballZ or
other wrapper enhancements in the future.
2017-11-30 15:47:38 -08:00
Jordan Borean
a12e1bfced
stat: added information about get_md5 deprecation to porting guide (#33334)
* stat: added information about get_md5 deprecation to porting guide

* Edit
2017-11-30 10:14:34 +10:00
Eike Frost
16081d2751 Add keycloak_client module for administration of Keycloak clients (#31716)
Allows administration of Keycloak (http://www.keycloak.org/) clients via the Keycloak REST API
2017-11-29 16:44:35 -05:00
Toshio Kuratomi
6e36354740 Update version numbers for the release 2017-11-29 12:12:44 -08:00
Michihito Shigemura
63231457a1 Update links in become.rst (#33383) 2017-11-29 19:48:33 +00:00
Matt Martz
84b8f674a7
Fix py3 docs build (#33345)
* Open file in binary mode to support py3 writes using bytes

* Update sort filter to use an attribute, so that py3 can sort dictionaries
2017-11-28 12:05:19 -06:00
Brian Coca
08f1d1972e correctly document random doc range (#33308)
* correctly document random doc range

fixes #33226

* Edited for clarity.
2017-11-28 01:26:36 -08:00
Matt Martz
4fe08441be Deprecate tests used as filters (#32361)
* Warn on tests used as filters

* Update docs, add aliases for tests that fit more gramatically with test syntax

* Fix rst formatting

* Add successful filter, alias of success

* Remove renamed_deprecation, it was overkill

* Make directory alias for is_dir

* Update tests to use proper jinja test syntax

* Update additional documentation, living outside of YAML files, to reflect proper jinja test syntax

* Add conversion script, porting guide updates, and changelog updates

* Update newly added uses of tests as filters

* No underscore variable

* Convert recent tests as filter changes to win_stat

* Fix some changes related to rebasing a few integration tests

* Make tests_as_filters_warning explicitly accept the name of the test, instead of inferring the name

* Add test for tests_as_filters_warning

* Update tests as filters in newly added/modified tests

* Address recent changes to several integration tests

* Address recent changes in cs_vpc
2017-11-27 17:58:08 -05:00
Samer Deeb
cbf28c20cb Add Support for Mellanox switches: first module: mlnxos_command (#33121)
* Add Support for Mellanox switches: first module: mlnxos_command

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* Add cliconf support for mlnxos

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* 1- Fix short description, 2- remove waitfor

Signed-off-by: Samer Deeb <samerd@mellanox.com>

* remove usage of check_args

Signed-off-by: Samer Deeb <samerd@mellanox.com>
2017-11-27 20:55:08 +00:00
gaellick
bb38e34fc5 add prequisites for ubuntu dev env (#30713) 2017-11-27 14:58:13 -05:00
Pilou
16bcb0393e dev_guide: format code in testing_units_modules.rst (#33009)
* dev_guide: highlight Python code snippets

* dev_guide: use monospace for inline source code

* dev_guide: use links for classes and methods

Methods and classes prefixed with :method: and :class: will become
links once we have documentation for the relevant classes and methods.

Thanks to Toshio for pointing that.
2017-11-27 14:41:53 -05:00
Wolfgang Felbermeier
817a5efff9 Fix css of elbow indentation for firefox (#33225) 2017-11-27 13:13:17 +10:00
Brian Coca
18a4cd3985
draft implicit localhost docs (#31840)
* draft implicit localhost docs

* updated per feedback

* corrected docs to follow desired behaviour

* Edits
2017-11-22 19:13:56 -05:00
Sebastian Safari
a05bbb8a1b Update location of facts.py on module dev documentation (#32209)
* Update location of facts.py

I spent some time trying to find out where it was, since it's a 404 on a google search.

* Edits
2017-11-22 15:26:27 -08:00
Brian Coca
be00d93eb4 update with implicit localhost (#33146)
* update with implicit localhost

* Minor edit
2017-11-22 14:48:40 -08:00
Sorin Sbarnea
33ce1e1886 Documented use of ANSIBLE_STRATEGY variable (#32973)
Change-Id: I4a14520c14a9d93f06b235eb79720fc674e20cb5
2017-11-22 14:47:21 -08:00
Richlv
f8a51355c7 Update playbooks_blocks.rst (#31088)
fix "block:" being referenced as "blocks:"
2017-11-22 14:40:41 -08:00
Siddharth Singh
6674b8e155 Changed Indentation (#31031)
The children 'northeast', 'northwest', 'southwest' weren't properly indented in yaml code.
2017-11-22 14:39:24 -08:00
Wolfgang Felbermeier
496ce388ab documentation: render nested return dicts for more then one level (#33143)
* Render nested return value documentation for more then one level
in the generated webdocs.

* Remove unnecessary code and cleanup

* Implement recursive option documentation

* Build elbow intendation style for options and return documentation
2017-11-22 16:53:53 -05:00
Strahinja Kustudic
673ec2cb78 Add changes to succeeded/failed tests to the 2.4 porting guide (#33201)
* Add changes to succeeded/failed tests to the 2.4 porting guide

* Edit for grammar and clarity
2017-11-22 16:14:31 -05:00
Simon Wydooghe
c0fced0d89 Add 'datacenter' keyword arg to secrets.py (#24598)
Fix adds documentation about 'datacenter' in environment variable which is required for gce.py dynamic inventory.
2017-11-22 15:17:29 +00:00
scottb
6ac9d05de6
Removing obsolete version behavior callout notes - initial pass. (#33172)
* Removing obsolete version behavior callout notes - initial pass.

* Fixed example text punctuation.

* Removed old version callout.

* Typo fix

* Updated example

* Fixed awkward sentence

* Fixed incorrect feature name

* Reinstated current version callout
2017-11-21 20:14:27 -08:00
Ganesh Nalawade
0ddf092ae3
Add new filter to parse xml output for network use cases (#31562)
* Add new filter to parse xml output for network use cases

Fixes #31026
*  Add parse_xml filter
*  Add documentation for parse_xml filter

* Edited for clarity.

* Fix review comment and add unit tests

* Fix unit test CI failure

* Fix CI issues

* Fix unit test failures

* Fix review comments

* More copy edits.
2017-11-21 12:16:18 +05:30
André Althaus
a9b15ce881 Scan group_vars/host_vars in sorted order 2017-11-20 21:57:42 -05:00
Tom Mast
2995439fbf Fixed simple typo on galaxy page (#33033) 2017-11-18 10:22:58 +01:00
John R Barker
6e4aa49a31 No hardcoding roadmaps (#32981) 2017-11-16 08:03:10 -08:00
Brian Coca
afc460c943 tollerate 'string' descriptions 2017-11-14 11:18:48 -05:00
Julien Palard
73d6975611 FIX: Missing space in intro_inventory.rst 2017-11-14 10:54:02 -05:00
Major Hayden
6957339fce [Docs] Fix old YAML style in async docs (#31421)
* [Docs] Fix old YAML style in async docs

This patch fixes some old-style YAML in the documentation for
asynchronous playbooks.

* Removed hard-to-localize colloquialisms
2017-11-13 18:32:37 -08:00
Jiri Tyr
f4f5c4d92a Documenting second parameter of the default filter (#31184)
* Documenting second parameter of the default filter

* Edited for clarity and grammar.

* Adding missing colon
2017-11-13 15:51:22 -08:00
Matt Martz
99d4f5bab4 Remove uses of assert in production code (#32079)
* Remove uses of assert in production code

* Fix assertion

* Add code smell test for assertions, currently limited to lib/ansible

* Fix assertion

* Add docs for no-assert

* Remove new assert from enos

* Fix assert in module_utils.connection
2017-11-13 11:51:18 -05:00
Brian Coca
a0c0076cfb added note about serial behaviour (#32461)
* added note about serial behaviour
2017-11-12 14:05:34 -08:00
Toshio Kuratomi
faa74a8ccd
Add the template lookup escaping to the 2.4 porting guide (#32760)
* Add the template lookup escaping to the 2.4 porting guide
2017-11-12 14:01:14 -08:00
Toshio Kuratomi
e07cbb033f Keywords docs (#32807)
* Fixup keyword dumping

* Clarify introductory text
* Turn links in the keyword description into seealso entries in the rst.

* Have plugin_formatter cleanup trailing whitespace

The indent filter in jinja2 < 2.10 indents blank lines by default which
leads to trailing whitespace.  Cleanup after that filter.

* Edits

* Copy edit
2017-11-10 16:59:26 -08:00
Will Thames
316e7939d6 [cloud] Improve aws testing and use {{ region }} var (#26892)
* Protect AWS credentials from accidental commits

* Improve documentation for IAM policies

* Update ELB tests to be multi region

Allow AZs to reflect the region in which the tests are run.

This will not work for regions with fewer than three AZs,
but those are relatively rare
2017-11-09 11:56:31 -05:00
Brian Coca
76202bc7c3 removed since 1.2 2017-11-09 09:59:43 -05:00
cnasten
f1fe467c22 nso_config module for setting configuration in Cisco NSO (#30973) 2017-11-09 13:34:41 +00:00
Jordan Borean
2f93b7bcb5
win_become: add info about recent admin changes (#32583)
* win_become: add info about recent admin changes

* edits from review
2017-11-09 10:02:33 +10:00
Jordan Borean
15c10981a0
win_dsc: update documentation for latest DSC changes (#32581)
* win_dsc: update documentation for latest DSC changes

* review changes
2017-11-09 10:02:17 +10:00
Trishna Guha
4cc7a89244
Add trishna to committer list (#32663)
Signed-off-by: Trishna Guha <trishnaguha17@gmail.com>
2017-11-08 06:46:16 +00:00
Ganesh Nalawade
ff20ac6c52
Add ganeshrn to committer list (#32662) 2017-11-08 11:12:26 +05:30
Kedar K
9b896ca712
add kedarX to commiters list (#32659) 2017-11-08 08:03:37 +05:30
Martin Krizek
cd80f26035
Add mkrizek as a commiter (#32644) 2017-11-07 18:51:58 +01:00
Sam Doran
d60a1f39d6
Update committers (#32646) 2017-11-07 12:44:55 -05:00
Matt Clay
ddae61aab0 Update people section of committer guidelines. 2017-11-07 09:29:25 -08:00
Brian Coca
4fe2c8fece added missing sam 2017-11-07 12:20:43 -05:00
Sloane Hertel
8478b5b6f8
add shertel as a commiter (#32639) 2017-11-07 11:11:53 -05:00
Matt Davis
8a24116dcb
remove experimental warning from become/runas (#32604)
* updated docs/changelog accordingly
2017-11-06 15:37:45 -08:00
Dylan Silva
4bcab82cdb
2.5 roadmap documentation (#32333)
* 2.5 roadmap

* Update ROADMAP_2_5.rst

Minor edits for caps.

* Formatting

* Network Documentation wording & formatting

* Remove smart quotes

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst

* Update ROADMAP_2_5.rst
2017-11-06 08:40:32 -08:00
James Beake
162ca628d4 fix typo/ URI error (#32531)
URI uses singular: "Listener"

Using current command Listener(s) - plural generates the following error:
PS C:\windows\system32>   winrm enumerate winrm/config/Listeners
WSManFault
    Message
        ProviderFault
            WSManFault
                Message = The WS-Management service cannot process the request. The resource URI does not support the Enumerate operation.

Error number:  -2144108495 0x80338031
The WS-Management service cannot process the request because the WS-Addressing Action URI in the request is not compatible with the resource.
2017-11-05 11:46:07 +00:00
Michihito Shigemura
c34c1b6ebd Fix typo/link in plugins/cache 2017-11-02 19:40:09 -04:00
Dmitry Marakasov
843fba509f Documentation typo fixes (#32473) 2017-11-02 11:15:53 +00:00
Jordan Borean
d43985aa46
windows development: info about module_utils and requires (#32060)
* windows development: info about module_utils and requires

* Edits.

* update for CI fix

* removed link to Python module utils
2017-11-02 07:15:25 +10:00
Brian Coca
52c97a1cf4 added doc notes about vars plugins in precedence 2017-11-01 11:40:49 -07:00
Victor Martinez
4faf4ff215 Fixed typo (#32450) 2017-11-01 16:46:19 +00:00
Brian Coca
41685fb516 fix precedence issue with facts and vars (#32302)
avoid making gathered facts high precedence, only set_fact is supposed to be.
vars set via set_fact with cacheable are higher precedence than plain facts.

Previously (after 6fbd0a8bb5) regular facts would end up with a
higher precedence than host or play vars, but they should not be. Facts were getting added to 'non_persistent_facts' (equivalent to 'register' vars) which is higher precedence than facts should be.

added 'cacheable set_facts' to precedence docs

'ansible_facts_cacheable' ->  '_ansible_facts_cacheable' (made 'private')
2017-11-01 11:42:17 -04:00
Toshio Kuratomi
42655f737a
Clarify the release and maintenance cycle (#32402)
* Clarify the release and maintenance cycle
* Namespace refs a little
* Fix an unrelated problem with plugin return docs to fix docs build
2017-10-31 22:08:14 -07:00
irsl
b456e637e0 become-user example was incorrect
Example was incorrect:
--become-user doesn't imply --become (http://docs.ansible.com/ansible/latest/become.html)
2017-10-29 00:58:26 -04:00
Ed Santiago
47fb002c88 (minor) fix broken link, awkward phrasing (#32085)
* (minor) fix broken link, awkward phrasing

Simple transposition error was resulting in a link not
being properly htmlified.

Also clean up redundant 'this' and trailing whitespace.

Signed-off-by: Ed Santiago <santiago@redhat.com>

* Edits
2017-10-27 21:39:23 -07:00
Greg DeKoenigsberg
80031720d1 Deprecate old community guide (#32266)
For anywhere we still have links, we want to deprecate this page and point them to the right new page.
2017-10-27 17:49:08 +01:00
Greg DeKoenigsberg
c5b4d53c09 Update index.rst to point to new community guide (#32263)
We made this change a couple of months ago, deprecating community.html in favor of community/index.html and its full guide, but the change was never made here in the index.
2017-10-27 17:48:14 +01:00
Aaron Huslage
01af68911f Change 'connection' to 'inventory' in description
Fixing a copy/paste typo.
2017-10-25 16:25:19 -04:00
Toshio Kuratomi
cf2c22770a Update release and maint for new release 2017-10-25 12:52:22 -07:00
John R Barker
1d86205933 Correct formatting --arguments (#31808)
* Correct formatting

* Use RST :option:

* ansible-pull --vault-password-file

* Streamlined the language a bit in the intro.

* Exclamation point removal!
2017-10-24 13:23:04 +01:00
Matt Clay
36b13e3e3d Fix ansible-test default image. (#31966)
* Add openssh-client to default docker container.
* Include Azure requirements in default container.

To do so, handling of pip requirements was updated to install each
set of requirements separately and then run a verification pass to
make sure there are no conflicts between requirements.

* Add missing --docker-no-pull option.
* Add documentation for the azure-requirements test.
2017-10-20 08:48:01 -07:00
mikedlr
fbbffbabde Mdd module unit test docs (#31373)
* new documentation for unit testing - especially module unit testing

* unit test documentation reformatting and further fixes

* unit test documentation - point to online coverage reports & fix bad spaces

* Small copy edits.

* First pass copy edit / rewrite. More info needed.

* testing documentation - clean up structure, especially code coverage - reduce repetition

* module unit test documentation - improved introduction

* testing documentation - more fixes from and inspired by review from dharmabumstead

* testing documentation - fixes from mattclay + some other minor tweaks

* More copy edits.

* testing documentation - further fixes from review

* Copy edits

* Copy edits

* More copy edits.
2017-10-19 13:36:57 -07:00
Dan Bohea
be3f911ce3 Typo on "Prompts" page (#31882) 2017-10-19 10:50:27 +10:00
Dag Wieers
3182a878b5 Fix small typo 2017-10-18 16:47:58 +02:00
Jordan Borean
836677522d fixed up code-block for powershell block 2017-10-17 13:36:49 +10:00
Abhijit Menon-Sen
a84545dc33 Fix typo 2017-10-16 20:58:27 +05:30
Gregory M. Dulin
29a5938fb1 Update --extra-vars documentation. Fixes #11647 (#31433)
* Update --extra-vars documentation to address #11647

* Fix some grammar

* Fix indentation

* Reshuffle and add versionadded tags

* Remove code-block tags

* Add lf after versionadded lines
2017-10-16 10:50:38 -04:00
wxdao
8a86746223 Fix typo in playbooks_error_handling (#31636) 2017-10-12 21:08:35 -07:00
Jordan Borean
f2fed10ad8 update Windows docs (#30783)
* first round of splitting and expanding Windows docs

* Added info about WinRM and started the usage page

* more details onf usage around command/shell

* added more info

* missed a page

* added info about hotfix and ps upgrade script

* Added DSC information

* filled in FAQ and fixed up links

* changes per PR review and typo fixes found by myself

* fixed sanity check

* updated external script URLS

* Edits

* Edits

* Edits

* Copy edits.

* More copy edits.

* Added info about becoming a local service account

* some formatting changes on become and DSC indent fix

* Copy edits/rewrites

* Copy edits/rewrites

* minor updates to UAC text, typos

* minor wording updates

* minor wording tweaks/typos

* minor wording tweaks/typos

* minor tweaks/typos

* fix indent issue

* fix title underline length

* fix quote issue
2017-10-12 18:40:47 -07:00
Peter Weldon
94a558887a Fix typo in command output of encrypt_string example. (#31601) 2017-10-11 14:24:33 -07:00
Tim Rupp
20e546258d Adds new committer to Ansible core (#31544)
This is me (Tim) signing and agreeing to the committer guidelines.
2017-10-11 22:08:47 +01:00
Brian Candler
6f9e2b9a63 Add ellipsis to indicate YAML example is excerpt, not standalone 2017-10-11 17:04:12 -04:00
Brian Coca
2ed46e04f4 more updates to plugin/config generation (#30787)
* fixed module generation

added missing lookup page
point to plugins when plugins
made modules singular
add display for verbose an debug messages
nicer templating, changed generation order for ref
corrected links
moved most of lookup docs to plugin section

* Copy edits
* Fixed typos
* Clarified wording
2017-10-11 00:15:25 -04:00
Brian Coca
d84df2405d move from with_<lookup>: to loop:
- old functionality is still available direct lookup use, the following are equivalent

  with_nested: [[1,2,3], ['a','b','c']]

  loop: "{{lookup('nested', [1,2,3], ['a','b','c'])}}"

- avoid squashing with 'loop:'
- fixed test to use new intenal attributes
- removed most of 'lookup docs' as these now reside in the plugins
2017-10-10 15:43:49 -04:00
Toshio Kuratomi
c81314dcb9 Add a hack to test whether type=path should be used in a module 2017-10-09 21:15:56 -07:00
Brian Coca
dc69af50dc clarified inventory_dir changes for 2.4 (#31484)
* clarified inventory_dir changes for 2.4

added example on how to restore (mostly) old behaviour for add_hosts

fixes #30901
2017-10-09 20:56:32 -07:00
Brian Coca
7d49b27218 added toggle to control vars plugin behviour
this should allow user to control how they want the playbook dirs inspected
for additional vars, default now reverts to 2.3 behaviour (top).
corrected paths order
minor doc reword
2017-10-09 12:31:15 -04:00
Richlv
1037c211d9 Update playbooks_lookups.rst
fix doublequote being used in place of the colon
2017-10-09 10:00:05 -04:00
Lindsay Hill
146f90e16b Fixed RST hyperlink issues (#31394) 2017-10-06 01:30:10 -07:00
sduthil
15dffe04dd fix misformatted docsite link (#31384)
reason: The link is showing verbatim in the docs, where it should only
show "knowledge base article".

Also, generating the docs shows a lot of:

docs/docsite/rst/win_acl_module.rst:424: WARNING: Unknown target name: "know ledge base article<https://access.redhat.com/articles/rhel-top-support-policies>".
2017-10-05 18:52:30 -07:00
John R Barker
b79d15e67f Improve and link Network Proxy docs (#31316)
* Improve and link Network Proxy docs

It is possible for proxy issues to cause "unable to open shell", so
detail there.

Having the "how-to" in the debug page makes more sense than on the
porting page, so move it.

Fixed a few formatting issues at the same time.

* Edits

* typo
2017-10-05 18:47:32 +01:00
Brian Coca
5085c3b859 made note about cwd not working for hostlist anymore (#31258)
* made note about cwd not working for hostlist anymore

fixes #31041

* Edits
2017-10-04 14:18:43 -04:00
Jorgen
c41f781e1d Make YUM repo URL clickable again (#31264)
Make YUM repo URL clickable again
2017-10-03 22:32:20 -07:00
Andreas Olsson
ba0b91b51b Remove git:// urls from docsite and from packaging (#30459)
It's almost always preferable to clone by way of https:// rather than
using the bare git:// protocol. Not only does https:// provide
stronger guarantees it also plays nicer with corporate proxies, etc.
2017-10-03 12:16:25 -07:00
Michihito Shigemura
a71ca66e6e Fix typo in dev_guide/testing 2017-10-02 16:11:08 -04:00
Michihito Shigemura
78fd326908 Fix typo in dev_guide/developing_program_flow_modules 2017-10-02 16:10:45 -04:00
Dylan Silva
614a2b403e fixed url issue for rpm location (#31164)
Thanks @thaumos!
2017-10-02 02:20:03 -07:00
Michihito Shigemura
d0d1c7d249 Fix typo in dev_guide/developing_plugins (#31142) 2017-10-01 02:00:38 -07:00
Michihito Shigemura
221c01ff49 Fix typo in dev_guide/developing_modules_general (#31122) 2017-10-01 01:39:02 -07:00
Michihito Shigemura
b7b8c669a3 Fix typo in dev_guide/developing_modules_documenting (#31120) 2017-09-30 17:19:09 -07:00
Daniel Linder
90dd698b86 Example of idempotent (pseudo-)random() usage. (#31048)
Add note to use idempotent random() seed based on inventory_hostname.
2017-09-28 12:59:10 -07:00
Luke Short
c6a676c025 correct the Python 3 Pip environment setup instructions (#30988) 2017-09-28 13:21:38 +10:00
tom-clx
04bfbb14d6 Update playbooks_blocks.rst (#24069)
* Update playbooks_blocks.rst

The rescue section documentation should be clear that successful completion of a rescue section will override other error handling behavior.

* more precise rescue docs

explains in detail the consequences of successful rescue
2017-09-27 14:57:42 -07:00
Dag Wieers
e63d949951 Add a blank line, and use the Copyright format as used during rewrite
So there is a discrepancy between the dev guide and what has been changed on disk by toshio.
Not a big deal, but needlessly confusing.
2017-09-27 20:44:22 +02:00
Brian Coca
cd5cadfe69 added note about inventory_dir new behaviour (#30865)
* added note about inventory_dir new behaviour
2017-09-27 12:00:06 -04:00
Michihito Shigemura
b3cee37dc1 Update links in style_guide/trademarks (#30809) 2017-09-27 01:29:56 -07:00
Brian Coca
17f094bb6a corrected import_play into to import_playbook (#30853)
* corrected import_play into to import_playbook

fixes #30744
2017-09-26 17:27:21 -04:00
Matt Martz
d40eff720c Update API example for 2.4 2017-09-26 14:39:36 -04:00
scottb
6c732bb670 Plugin doc update edits for #30490 (#30889)
* Edit pass 1 for #30490 - command line tools and developing plugins.

* Continuing edit pass for #30490. WIP

* Last round of copy edits for #30490.
2017-09-25 15:37:33 -07:00
cclauss
25e17b4035 Clearify that Python 3 support is still a tech preview (#30789)
setup.py does not contain any Python 3 trove classifiers.
2017-09-25 12:36:58 -07:00
Michihito Shigemura
b3177383da Fix typo in docs spelling_word_choice (#30785)
shocked that someone else spells the correst way, like me
2017-09-25 11:09:18 -04:00
Brian Coca
8d56064ce4 fixed typo in if, restore module docs 2017-09-24 10:18:21 -04:00
Michihito Shigemura
303d622dcb Refactor doc resources in style_guide (#30794)
- Change links from http to https
- Correct or remove dead links
2017-09-23 09:13:17 +00:00
Brian Coca
b233f3f296 updated plugin docs (#30490)
* updated  docs

- for devs:
  - added inventory/vars section
  - made some updates to general section and other plugin types
- for users:
 - added 'user' plugin section to start describing the plugins
 - docs on types, what they are and how to use

- removed ref to deleted AUTHORS file
- corrected several typos/headers
- added descriptions to config.rst template
- ignore generated files for cli/plugins and config
- remove new generated files on `make clean`
- moved details from devguid and intro doc to plugin specific pages
- pretied up lookup notes
- changed precedence ref to not conflict config
- removed duplicate config data, as config is autogenerated and up to date
- put new plugins under playbooks
- added `pass` cause rst/python dislikes fractions
- removed dupe in .gitignore, alpha sorted to avoid moar dupes
- added try cause rst/python freaks out

* generate plugins into their own dir

only do plugins that support docs
use toctree from main plugins page
2017-09-22 23:19:50 -04:00
Matt Bruzek
aaaf88908d Adding a section to the FAQ about array notation. (#30782)
* Adding a section to the FAQ about array notation.

* Fixing spelling of jinja and Celsius.

* Adding an example that uses dots.
2017-09-22 19:02:51 -04:00
Michihito Shigemura
b5546328dc Fix typo in docs grammar_punctuation (#30718) 2017-09-22 10:18:26 +00:00
David Moreau Simard
f8230d961d Link to all the porting guides instead of just the 2.0 one (#30671) 2017-09-21 10:32:13 +00:00
jborean93
0e22afef52 fix for make webdocs 2017-09-20 22:45:24 -04:00
Dag Wieers
31e7d735a3 win_environment: Make this the Windows reference module
As discussed before we selected win_environment to the documentation,
and point to win_uri for a more advanced module.

If we want to make this the reference module, we have to get this one
absolutely right in every possible way.

This PR cleans up both win_environment and win_uri, and makes the
required changes to the windows module development section.
2017-09-21 03:20:17 +02:00
Brian Coca
5220f30244 decelerate docs! 2017-09-20 17:30:59 -04:00
Dylan Silva
2f67dd1e0f Updated release table for docs (#30649)
- Updated table to reflect release of 2.4
- Added in 2.5 as current devel
2017-09-20 13:58:21 -07:00
Brian Coca
a030472092 More porting updates (#30635)
* Update porting_guide_2.4.rst with more docs and some rst fixes
2017-09-20 15:12:01 -04:00
Monty Taylor
700a032bf1 Add an example of complex return argument (#28610) 2017-09-20 15:51:45 +01:00
Brian Coca
22c8522cbf added missing feature info (#30560)
* added missing feature info

mostly config related

* Copy edit

* Copy edit

* Copy edit. Clarified warning.
2017-09-19 17:43:15 -04:00
Austin S. Hemmelgarn
d5ae9d1018 Fix build on Python 3.x by using sys.maxsize. (#30424)
As outlined in https://docs.python.org/3.1/whatsnew/3.0.html#integers,
sys.maxint doesn't exist anymore in Python 3.x because there is no maximum
value for integers in Python 3.x.  sys.maxsize is present in all
versions of Python that are currently supported by Ansible, so use that
instead as an arbitrarily large index value.

Fixes the following build error when building with Python 3.x:
make -j1 docs
mkdir -p ./docs/man/man1/ ; \
PYTHONPATH=./lib docs/bin/generate_man.py --template-file=docs/templates/man.j2 --output-dir=docs/man/man1/ --output-format man lib/ansible/cli/*.py
Traceback (most recent call last):
  File "docs/bin/generate_man.py", line 253, in <module>
    allvars[cli_name] = opts_docs(cli_class_name, cli_name)
  File "docs/bin/generate_man.py", line 119, in opts_docs
    'long_desc': trim_docstring(cli.__doc__),
  File "docs/bin/generate_man.py", line 34, in trim_docstring
    indent = sys.maxint
AttributeError: module 'sys' has no attribute 'maxint'
make: *** [Makefile:347: generate_asciidoc] Error 1
2017-09-19 16:23:16 -04:00
Adrian Likins
da15cf1f54 Generate plugin rst (#28901)
Generate rst docs for plugins 

Based on rst generated for modules. But generated plugin
docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst
( docs/docsite/rst/plugins/connection/ssh.py for ex)

* move plugins docs to rst/*_plugins/ subdirs for namespace
* Only gen support pages for modules for now.
* Add generated plugin docs to gitignore* add list_*_plugins templates
* support MODULES/PLUGINS filters for make htmldocs

   Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for.

* fixup 'historical' version_added, skip plugins/loader.py
* Fix plugins_by_support ref link to new plugins/*/ location
* use :ref: for common_return_values, allow empty version_added
* warnings on missing doc info
* add a prefix to _random_choice
  It was colliding with the target for random_choice plugin
2017-09-19 11:14:27 -04:00
Toshio Kuratomi
c82cf791dd Add a code-smell test for smart quotes and remove smart quotes from all files 2017-09-18 16:49:16 -07:00
Brian Coca
1062f52f4c cleanup generated CLI rst 2017-09-18 16:20:49 -04:00
John R Barker
5a256dd1c0 porting_guide_2.4 stub entries (#30456)
Addtions to porting_guide_2.4

* deprecated notice for win_package return values
* Added vars plugins, config api, inventory plugins.  These were mostly backwards compatible.
  Added notes for users and devs to check out new features once i write the 'feature docs' I'll
  come back and link to them from here
2017-09-17 16:57:10 -07:00
Adrian Sadłocha
22f3898412 Fix a typo in docs 2017-09-17 19:13:21 -04:00
James Cammarata
366a9d861f Cleaning up use of include: in docs (#30466)
* Cleaning up use of include: in docs

Switching to import_*/include_* instead.

* Update playbooks_best_practices.rst

* Fix rst syntax
2017-09-17 18:02:46 +00:00
John R Barker
785e604c57 Porting Guides 2.4 (#24539)
* Porting Guides for Ansible Versions

Improve the user facing documentation.
Tell people what changes they need to make

* More porting guides

* Link porting guides from TOC

* Link porting guides from CHANGELOG.md

* typo in link

* Review feedback

* Better CHANGELOG links

* Better links

* code blocks

* Minor changes

* Correct links, comment out network section in 2.4

* Typos

* Revert non 2.4 changes

* Add placeholders for other items

* multiple inventory

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* Update porting_guide_2.4.rst

* add win_command/win_shell escaping notes

* Added some windows porting info

* Edit for grammar

* Correct links, delete Net Platform Agnostic

* 2.5 link

* Network changes in 2.4

* facts_namespacing was pushed back to 2.5

Due to lack of time we pushed this back to 2.5 so that the facts in the namespace could be shortened.

* Python version

* Remove FIXMEs - move to seperate PR
2017-09-16 12:10:12 +01:00
Ganesh Nalawade
11310b8c4a Update removed_in_version to 2.9 for network module top level cred args (#30416)
* Update removed_in_version to 2.9 for network module top level credential args

* Add documentation
2017-09-15 21:20:07 +05:30
Toshio Kuratomi
8a2f069468 Document boolean default value treatment (#30062)
* Consistency and document treatment of default bool values

* Document that default bool values can be any Ansible recognized bool.
  choose the one that reads better in context
* For fragments used by the copy module, make bool types use type=bool and not choices

* Edit for clarity
2017-09-14 13:27:16 -07:00
Adrian Likins
dfc0084f01 rename dev..general_OLD.rst to ._rst (#30291)
So we don't try to build the rst, since it causes
lots of warnings to be shown and doesn't render correctly.
2017-09-14 11:23:36 -04:00
Adrian Likins
9cc63326b1 Misc docsite fixes (#30290)
* Fix refs for local_facts and various cli :option:
* Fix dev_guide/testing_pep8 refs
* remove ref to non-existing 'developing_test_pr'
* Fix ref to ansible-vault encrypt_string
* Removed hard-to-localize colloquialism.
* Rename '_ansible-pull' in playbooks_intro.

It was conflicting with rst/ansible-pull.rst. Nothing
seems to reference it.

* Add explicit targets for and update refs

Replace some ':doc:' use with ':ref:'.

Replace some :ref: to section names with explicit targets
(:doc:`Dynamic vs. Static` -> :ref:`dynamic_vs_static` etc)

* The 'YAML+Jinja' syntax lex fails here, so just use yaml

Since the yaml+jinja highlight fails, code wasnt highlighted
at all, but 'yaml' works more or less.

* just use no lexer for the < python2.6 examples

py3 will fail highlighting them, and 'python2' throws
a lexer warning, and nothing actually highlights it, so
just disable.
2017-09-14 11:17:56 -04:00
Aren
60d9a12efd swapped out key-value pairs for multi-line YML (#30277) 2017-09-14 13:06:33 +10:00
John Patrick
fc5b74fad2 fix broken rpm link (#29667) 2017-09-14 12:21:31 +10:00
John R Barker
ac6205b9e8 porting_guide_2.5.rst stub (#30311) 2017-09-13 23:20:51 +01:00
Adrian Likins
633263d535 add htmlsingle target (#30287)
For whatever reason, building the 'singlehtml' version of
the docs is much much faster than building the normal html
version.
2017-09-13 20:45:05 +00:00
Matt Clay
df941df01d Remove references to obsolete PR Mover. (#30298) 2017-09-13 20:43:19 +00:00
Ganesh Nalawade
530988666a Allow delegate_to if transport is not cli (#29945)
Fixes #29060

Allow delegate_to if transport is either nxapi or eapi.

Persistent connection uses `cli` transport and create
a local socket on control node. Hence delegate_to is not allowed
for `cli` transport.

However as `nxapi` and `eapi` transport does not use persistent connection
it is possible to use delegate_to in this case.
2017-09-12 21:34:13 +05:30
Dylan Silva
88aa0b7645 Fix bugs with modules_support.rst 2017-09-11 17:33:16 -07:00
Toshio Kuratomi
ff13d58c14 Remove use of unicode_literals as it is an anti-pattern
from __future__ unicode_literals leads to developer confusion as
developers no longer can tell whether a bare literal string is a byte
string or a unicode string.  Explicit marking as u"" or b"" is the way
to solve the same problem in the Ansbile codebase.
2017-09-11 13:33:51 -07:00
Abhijeet Kasurde
8f6626bd8f Misc typo corrections
Fix adds correction for typos

* Anisble to Ansible
* Fasle to False

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-09-09 10:25:50 -07:00
Cheng Lian
4c229e566e Fix minor formatting issue in python_3_support.rst (#29161)
Thanks @liancheng!
2017-09-09 06:02:18 +00:00
Luke Short
897f86561f document the required variables for using Windows certificates (#29112)
* document the required variables for using certificates when authenticating to Windows

* clarify that certificates are for local (non-domain) users
2017-09-08 12:52:25 +10:00
Will Thames
c749ecbd94 Add ansible-inventory-grapher to the list of tools (#29068)
* Add ansible-inventory-grapher to the list of tools

* Fixed minor typo.
2017-09-08 00:19:18 +00:00
jhawkesworth
3d5320adad fix typo in new jsonquery filter example that uses backticks (#29082) 2017-09-07 23:51:36 +00:00
Adrian Likins
52f2edf19d change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.
2017-09-07 15:46:53 -04:00
Adrian Likins
89c973445c generate rst doc pages for command line tools (#27530)
* let generate_man also gen rst pages for cli tools
* make template-file, output-dir, output format cli options for generate_man
* update main Makefile to use generate_man.py for docs (man pages and rst)
* update vault docs that use :option:
* Edits based on
6e34ea6242 and
a3afc78535

* add a optparse 'desc' to lib/ansible/cli/config.py 

  The man page needs a short desc for the 'NAME' field
  which it gets from the option parse 'desc' value.

  Fixes building ansible-config man page.

* add trim_docstring from pep257 to generate_man

  use pep258 docstring trim function to fix up any indention
  weirdness inherit to doc strings (ie, lines other than
  first line being indented.

* Add refs to cli command actions

To reference ansible-vaults --vault-id option, use:

:option:`The link text here <ansible-vault --vault-id>`

or:

:option:`--vault-id <ansible-vault --vault-id>`

To reference ansible-vault's 'encrypt' action, use:

:ref:`The link text here <ansible_vault_encrypt>`

or most of the time:

:ref:`ansible-vault encrypt <ansible_vault_encrypt>`
2017-09-07 15:44:20 -04:00
Brian Coca
f4fff54f68 clarify import_ docs (#28395)
* clarify import_ docs

* fixed izpellz

* Copy edits.
2017-09-06 23:50:50 -04:00
Will Thames
0d69b63c01 Additional simpler json_query documentation (#24041)
Since json_query treats backticks as delimiters for literals,
some of the examples in the json_query docs can be made a little
simpler. Rather than replacing such examples, demonstrate the
alternative
2017-09-06 20:48:12 -07:00
Brian Coca
c3550b58ed introducing ALSO YAML inventory (#28596)
* introducing ALSO YAML inventory

* Copy edits
2017-09-06 23:47:27 -04:00
Brian Coca
48da0597c0 document ansible_group_priority (#28777)
* document ansible_group_priority

* Copy edit pass
2017-09-06 23:36:01 -04:00
Matt Clay
fe90866819 Fix rst syntax issue in docs. 2017-09-06 19:39:07 -07:00
Dylan Silva
ecc1fbcc1d updated modules support page with new information (#29071)
* updated modules support page with new information

* Minor wording tweaks.
2017-09-06 16:48:26 -07:00
Sam Doran
02a362e7de Replace rst extension with html in message (#29022) 2017-09-05 16:59:25 -04:00