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

649 commits

Author SHA1 Message Date
Reid Wahl
ca91b361ce Fixes #28290: Added missing colon for paramiko host_key_auto_add line in network_debug_troubleshooting.rst (#28695) 2017-08-28 11:00:05 -07:00
Reid Wahl
3ca415f58c Fixes #21041: Add note to intro_inventory.rst that the Docker example is a playbook and not an inventory file (#28697) 2017-08-28 10:59:28 -07:00
Dag Wieers
ccb6b39f45 Corrected RETURNS -> RETURN 2017-08-28 10:09:21 +02:00
Brian Coca
203d8d2e6e added diff keyword to changelog/docs 2017-08-24 08:55:39 -04:00
René Moser
6397e68bfd doc: replace play_hosts with ansible_play_batch (#28526) 2017-08-23 07:49:32 +02:00
Matt Clay
871bd24358 Fix documentation references. 2017-08-22 17:09:28 -04:00
Shane McDonald
f108057f61 Bump version in docs layout (#28523) 2017-08-22 20:16:19 +01:00
Toshio Kuratomi
40ea448c7b Misc docs fixes
* Revise and link inline to the lists of modules

* Fix jinja2 objects.inv fallback path

* Fix bolding of deprecation marker

* Change module_support to link to lists via :doc:
  That links to the top of the page instead of a section.

* Add a short text for each list of maintained modules
* Change maintenance info to only display on core and network modules
2017-08-22 11:52:30 -07:00
Toshio Kuratomi
84ea2af4b6 Remove nonexistent special_interest-groups doc 2017-08-22 11:52:30 -07:00
Toshio Kuratomi
212499a489 On clean, remove the *_maintained.rst generated files 2017-08-22 11:52:30 -07:00
Jiri Tyr
5660b18b6a Adding missing period into the module doc template 2017-08-21 14:20:08 -04:00
David Kretch
beed59f303 Fix trailing space in ec2_vol example, fix 'the the' typos (#28440)
* Fix 'the the' typos, fix 'pahting' filename typo

* Change 'the the' typos to a single 'the'.
* Change `playbook_pahting.rst` to `playbook_pathing.rst`.

* Delete trailing space in ec2_vol example

Delete the trailing space in `instance: "{{ item.id }} "`, which makes the
example fail when run because it looks for instance "i-xxxx ".
2017-08-19 23:00:51 +02:00
David Moreau Simard
022ce7efee Docs for multiple asynchronous tasks (#24457)
* Add docs on the behavior of with_items flattening and nested lists

* Add docs on limiting the amount of concurrent async tasks
2017-08-18 13:02:35 -07:00
Andreas Maier
b900f4a3be Fixed return table in module docs generated by plugin_formatter.py (#25329) (#25330)
This change fixes two issues with the generated return table:

1. When specifying a list of strings in the 'description' field of a
   return value, it shows them in Python list syntax on the resulting
   web page, e.g. `['a', 'b', 'c']`.
2. When specifying more than one line for the 'sample' field, the
   result table gets damaged in the HTML output.

In addition, this change re-arranges the HTML tags produced in the
generated RST file such that they line up nicely and can better be
checked by humans for completeness.

Signed-off-by: Andreas Maier <andreas.r.maier@gmx.de>
2017-08-18 15:38:55 -04:00
Adrian Likins
2941e86671 Fix plugin_formatter.py -l / MODULES=none make webdocs
Fix the get_module_info check against the limit_to_modules
list so building a subset/none of the module docs works again.
2017-08-18 10:58:16 -04:00
David Moreau-Simard
e9d6d37589 Update release status for 2.3 to 2.3.2 2017-08-17 13:25:56 -04:00
Peter Sprygada
2e44d8913b update parse_cli documentation with more examples (#28258)
* update parse_cli documentation with more examples
2017-08-16 21:41:42 -07:00
Tom Paine
50d744c217 Update playbooks_filters.rst (#28271)
See #17266, password_hash has been updated to support passlib. The available hashes are listed on http://docs.ansible.com/ansible/latest/playbooks_prompts.html, but not here.
2017-08-17 11:34:35 +10:00
Sam Doran
b7aa38c0d8 Minor fixes to Developer Docs (#28302)
* Grammar and formatting corrections

Indent JSON code example.
Double backticks for inline code examples.

* Remove trailing spaces

* CI fixes
2017-08-16 17:56:53 -07:00
Matt Clay
b52aeeabfa Roadmap updates and docs fix. (#28287)
* Update on 2.4 roadmap progress.
* Fix docs syntax for Python 2.
2017-08-16 10:55:19 -07:00
Toshio Kuratomi
546187a8af Revamp the plugin_formatter doc generator
* Use a template to generate the category lists
* Refactor so that we first extract all of the data that we need to
  build the docs and then give that data to the templates to build with
* Add docs page listing modules ordered by support level
2017-08-15 23:12:08 -07:00
Toshio Kuratomi
af2073d057 metadata 1.1
* Add network value to support_by field.
* New support_by value, certified
* Deprecate curated in favor of certified
* Add conversion from 1.0 to 1.1 to metadata-tool
* Add supported by Red Hat field to ansible-doc output
2017-08-15 23:12:08 -07:00
CyberArk BizDev
d50d65d448 Added cyberarkpassword lookup plugin (#21857)
* Added cyberarkpassword lookup plugin

Added cyberarkpassword lookup plugin: It allows to retrieve credentials
(password, sshkey) from CyberArk Digital Vault
2017-08-15 23:06:46 -07:00
Jason McKerr
cc36153928 Update ROADMAP_2_4.rst 2017-08-15 14:58:26 -04:00
hsmtkk
3f9d6aa0f1 doc: fix a typo (#28215) 2017-08-15 15:37:41 +02:00
Aleks Daranutsa
f668f41822 Spelling and Grammar for playbooks_reuse.rst (#28174)
* Spelling and Grammar for playbooks_reuse.rst

* Minor edits.
2017-08-15 00:30:06 -07:00
scottb
b5179f9d46 CSS and HTML updates to enable versioned core documentation (#28097)
* Updated header for versioned docs.

* A tree in a golden forest.

* Fixed spacing.

* Fixed CSS and text for previous version header.
2017-08-14 11:21:33 -07:00
Toshio Kuratomi
fe2e17f7cd Update the intersphinx cached indexes
In case we build docs offline, we want to have a cached copy of the
documentation refs that are in the intersphinx docs we reference.
Update those to the lattest versions from their respective upstreams
2017-08-14 08:15:28 -07:00
René Moser
eec4434b9b doc: cloudstack: fix formating issue in guide (#28162) 2017-08-14 17:14:22 +02:00
Greg DeKoenigsberg
d78c199972 Update triage_process.rst to link to ansibullbot (#28137)
* Update triage_process.rst to link to ansibullbot

* fix typo
2017-08-14 00:03:40 -04:00
Greg DeKoenigsberg
75c0c545fd Create other_tools_and_programs (#28138)
* Create other_tools_and_programs

From https://github.com/ansible/community/issues/5.

* Fix typo
2017-08-13 22:32:28 -04:00
Greg DeKoenigsberg
b3ed699132 Copying code of conduct from community.rst (#28136) 2017-08-13 21:01:07 -04:00
Greg DeKoenigsberg
608c69279c Moving "communication" info from main community page (#28135) 2017-08-13 20:28:20 -04:00
Duncan Lock
9a2ae022f5 Format the versionadded block correctly (#28085)
Currently broken on the live docs site: http://docs.ansible.com/ansible/latest/playbooks_blocks.html
2017-08-14 02:14:03 +02:00
Prasad Katti
2c85ca3729 Formatting changes (#28133) 2017-08-14 02:09:19 +02:00
Greg DeKoenigsberg
5f6bfd81f8 Copying content from MODULE_GUIDELINES.md (#28131) 2017-08-13 17:13:54 -04:00
Adrian Likins
a2c8b03b46 fix rst format errors making rstcheck fail (#28129) 2017-08-13 15:59:13 -04:00
Greg DeKoenigsberg
3ec7e030bf Completed draft of How Can I Help 2017-08-13 14:35:40 -04:00
Greg DeKoenigsberg
f8f17c0c27 Add basic info on pull requests 2017-08-13 14:19:30 -04:00
Greg DeKoenigsberg
418dd0cd4a Iterating on How Can I Help
A little more content
2017-08-13 13:43:02 -04:00
Greg DeKoenigsberg
ba065637ff Add roadmap to development process doc 2017-08-13 13:08:33 -04:00
Greg DeKoenigsberg
792bfa657c formatting tweak 2017-08-13 12:39:03 -04:00
Greg DeKoenigsberg
e43d1da938 formatting tweak 2017-08-13 12:37:46 -04:00
Greg DeKoenigsberg
d6028c5de4 Slight changes to reporting bugs and features
as recommended by @gundalow in review for #27911
2017-08-13 12:36:03 -04:00
Greg DeKoenigsberg
ebfdbfb819 New content for bugs and features (#27911)
1. Copied over content from existing rst/community.rst page (which will be refactored once all these pages are in.)

2. For features, pointed to the Proposals section, which we should probably leave in ansible/proposals, where it is actively used.
2017-08-13 12:31:57 -04:00
Stefan Midjich
6e4c0143b4 Typo in module example code (#28064)
In the DOCUMENTATION constant there is a typo on line 85 of this rst file.
2017-08-11 23:35:14 +02:00
Thomas Stringer
e4cd899363 Add support for Azure 2.0.0 (#27920)
* Adapt azure_rm_resource_group to azure 2.0.0 + azure Cli support

* Fix exceptions in Azure ARM plugins

* update azure_rm_networkinterface documention to reflect required params

* change state param to not required for docs in azure_rm_subnet

* fix import to reflect azure==2.0.0 changes

* add aliases and fix docs for azure_rm_storageblob

* add resource_group_name alias to azure_rm_storageaccount_facts

* fix import bug due to change in azure==2.0.0

* fix args bug and enum modules issue

* update docs to reflect azure==2.0.0

* pin management clients to a specific api_version

* update docs to reflect the new azure-ansible-base python package

* add fallback for older api resource group listing

* rework azure dependencies installation

* refactor path joining to a cross-plat solution
2017-08-11 08:22:02 -07:00
Jordan Borean
7c59b66802 updated changelog for windows (#28040) 2017-08-11 08:55:51 +10:00
Brian Coca
914ae2fb26 added docs for undocumented play object entries 2017-08-10 16:22:34 -04:00
David Newswanger
ebb1d75ee0 fixed a syntax problem that was preventing a warning box from being displayed 2017-08-10 12:37:28 -07:00
Prasad Katti
2a63693580 Minor fix in docs 2017-08-10 14:18:59 -04:00
Brian Coca
940a74a93a fixed include_role doc example (#27986)
fixes #27985
2017-08-10 12:44:56 +10:00
Dag Wieers
49aa64a5b8 Various small changes and adding myself
Unfortunately, the Github interface does no longer allow me to edit a file in the GUI and then branch it in my personal clone for making a PR. It now only offers to make a PR using a branch on the ansible repository :-(

So committing this directly instead against my will, but per the guidelines this appears to be safe. Fingers crossed...
2017-08-09 23:29:11 +02:00
Jordan Borean
362f032449 Changed docs requires to new format (#27918) 2017-08-09 06:05:46 +10:00
Joseph Miguel
f88f4394c8 Update developing_api.rst (#25922)
* Update developing_api.rst

* Update developing_api.rst

Edited.
2017-08-07 14:40:29 -04:00
Arthur Kepler
d828449611 Corrects default arg format used by datetime filter (#27612)
This ensures the default datetime format matches that of
datetime.datetime. Docs updated to match as well.
2017-08-07 11:33:25 -07:00
Toshio Kuratomi
44935a5db6 Add a (disabled) code-smell test for detecting _ variables
We are reserving the _ identifier for i18n work.  Code should use the
identifier dummy for dummy variables instead.

This test is currently skipped as someone needs to generate the list of
files which are currently out of compliance before this can be turned
on.
2017-08-07 11:11:31 -07:00
Peter Sprygada
2d5908255a add parse_cli and parse_cli_textfsm to documentation (#27755)
* add parse_cli and parse_cli_textfsm to documentation

* Minor edits.
2017-08-07 07:19:31 -04:00
Scott Butler
c43a10bd69 Another clarifying note on Python supported versions. 2017-08-04 14:02:12 -07:00
Scott Butler
7d553aad29 Added note clarifying which version of Python 3 we support. 2017-08-04 13:59:38 -07:00
Scott Butler
699e0ccc32 Added note clarifying Python 3 supported versions. 2017-08-04 13:57:09 -07:00
Branko Majic
f78baa1300 Implement ability to limit module documentation building (#24576)
* Implement ability to limit module documentation building:

- Added new option to plugin_formatter.py to support passing-in a list of
  modules for which the documentation should be built.
- Updated docuemtnation Makefile to allow specifying list of modules via
  environment variables (defaulting to all modules).
- Update instructions for building documentation and module development to
  include commands and description of limiting module documentation builds.

* Updated implementation for limiting module documentation building:

- Pass list of modules (or None) to list_modules function instead of string.
- Move conversion of module list to argument parsing code.
- No special keywords. Default ("") means build all modules. For no modules just
  specify non-existing module name.
- Updated documentation to reflect the changes.

* Updated implementation for limiting module documentation building:

- Use better default value, and don't treat "" as special case.
- Conditionally invoke different variants of command in Makefile instead of
  using special value "".

* Minor edits

Wording tweak
2017-08-04 13:10:36 -07:00
Scott Butler
bfe470d391 Minor edit 2017-08-04 10:10:03 -07:00
Scott Butler
6d59ac1bb4 Updated per tech review feedback. 2017-08-04 00:05:16 -07:00
Scott Butler
b2ec984130 Updating packaging locations - incorporating review feedback. 2017-08-03 21:33:13 -07:00
Toshio Kuratomi
f4d7b9a596 code-smell test changes
* Create get_exception and wildcard import code-smell tests
* Add more detail to boilerplate and no-basestring descriptions
* Remove the no-list-cmp test as the pylint undefined-variable test covers it
2017-08-03 13:15:12 -07:00
Yaacov Zamir
48922660fe New model manageiq manageiq user (#26641)
* ManageIQ: manageiq_user module, module utils and doc_fragment

ManageIQ is an open source management platform for Hybrid IT.

This change is adding:
- manageiq_user module, responsible for user management in ManageIQ
- manageiq utils
- manageiq doc_fragment

* Handle import error

* Use formatting options

* group parameter is required

* changed doesn't need to be an attribute

* resource dictionary should contain values which isn't None

* move from monitoring to remote-management

* Use ManageIQ nameing convention

* Do not set defauts in arguments

* Use idempotent state parameter instead of action

* Check import error in the manageiq util class

* Update the miq documentation

* rename the connection configuration from miq to manageiq_connection

* All messeges start with non cap, fix typos, add examples, rename vars

* more typos fixes

* Make sure we insert only strings to logs by using % formating

* use suboptions keyword for the manageiq connection

* do not log the managiq connection struct (it include sensitive information like username and password)

* add missing from __future__

* ahh, wrong no-log line

* Use sub options
2017-08-03 10:49:47 -04:00
John R Barker
7f8aaf97de rst validation fix (#27698) 2017-08-03 15:07:46 +01:00
Greg DeKoenigsberg
aca4504e96 Simple "good enought" index page (#27667)
Removing the FIXME, just a peppy little starter page.
2017-08-02 21:51:58 +01:00
John R Barker
df58d943d3 Docs porting guides 2.0 & 2.3 (#27632)
* Create new "Porting Guide" section

Create new landing page
Add porting_guide_2.3

* correct CHANGELOG

* Document blocks

* Document named blocks

* OpenBSD & async action plugins

* OpenBSD & async action plugins

* versioadded for name

* review comments
2017-08-02 21:36:17 +01:00
scottb
3476b005b9 Initial pass at consolidating community content [work in progress] (#27661)
* Added placeholder topics for community info

* Setup community section index.

* Initial move of triage process docs.

* Typo/test

* Removed triage topic from index.
2017-08-02 12:38:29 -07:00
Adrian Likins
ac37be9761 update roadmap (multiple vault secrets merged) (#27644) 2017-08-02 11:15:12 -04:00
Abhijit Menon-Sen
20b0716948 Allow variables to be passed in to template lookup plugin (#18662)
This allows a single template to be evaluated with different values in
the same task. For example, with a template like 'x:{{a}}', one could do
something like this:

    - foo:
        a: "{{ lookup('template', 'x.j2', template_vars=dict(a=foo[item])) }}"
        b: "{{ lookup('template', 'x.j2', template_vars=dict(a=bar[item])) }}"
      with_items:
        - x
        - y

…and "a" and "b" would expand to different strings based on what we
passed in to the template lookup.
2017-08-02 09:29:27 +05:30
Ganesh Nalawade
70ce394840 Persistent connection timer changes (#27272)
*  Add command_timeout timer that defines the amount
   of time to wait for a command or RPC call before
   timing out.
*  Remove connect_retries and connect_interval configuration
   varaible and replace it with connect_retry_timeout to control
   the timeout value of connection to local scoket.
*  Make required changes to netowrk action plugins and relevant
   network files in module_utils.
*  Required documentation changes.
2017-08-01 11:45:45 -06:00
Brian Coca
842951f00d added note about not all tasks being 'delegatable' 2017-08-01 08:24:37 -04:00
Scott Butler
12e349fe48 Updated package locations. 2017-07-31 21:10:43 -07:00
Matt Davis
e4d153bd5d update WSL installation docs for current builds (#25237)
* supersedes #25224
2017-07-31 18:07:07 -07:00
Jordan Borean
ad5fa60a2b Added initial developing module doc for Windows (#27308)
* Added initial developing module doc for Windows

* Added to dev index, made formatting changes and moved obsolete docs

* changes based on PR feedback

* some typos and extra information

* Minor updates

* minor wording clarifications
* remove references to "remote" Windows hosts
* update template/text to remove legacy `#WANT_JSON`/`#POWERSHELL_COMMON`
* use per-execution envvars for ANSIBLE_KEEP_REMOTE_FILES instead of stateful

* fix up minor sanity check issue
2017-08-01 08:02:56 +10:00
Matt Clay
51bd07204b Revert "Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)"
This reverts commit 520696fb39.
2017-07-27 18:15:56 -07:00
Toshio Kuratomi
520696fb39 Revert "Allow ini plugin to load file using other encoding than utf8." (#27407)
* Revert "Update conventions in azure modules"

This reverts commit 30a688d8d3.

* Revert "Allow specific __future__ imports in modules"

This reverts commit 3a2670e0fd.

* Revert "Fix wildcard import in galaxy/token.py"

This reverts commit 6456891053.

* Revert "Fix one name in module error due to rewritten VariableManager"

This reverts commit 87a192fe66.

* Revert "Disable pylint check for names existing in modules for test data"

This reverts commit 6ac683ca19.

* Revert "Allow ini plugin to load file using other encoding than utf8."

This reverts commit 6a57ad34c0.
2017-07-27 17:08:31 -07:00
Toshio Kuratomi
3a2670e0fd Allow specific __future__ imports in modules
We do want to allow certain from __future__ imports in modules that make
it easier to code compatible python2 and python3.  Note that
unicode_literals is specifically left out and should never be allowed.
Now that python-3.4+ allows u"" there's no good reason to use
unicode_literals.

Also switch tables in the validate_modules documentation to simple table format
2017-07-27 15:37:26 -07:00
Yannig Perré
6a57ad34c0 Allow ini plugin to load file using other encoding than utf8.
- New option for ini plugins: encoding
  - Add a new option encoding to _get_file_contents
  - Use replace option in test/runner/lib/util.py when calling decode on stdout/err
    output when diff have non-utf8 sequences
2017-07-27 14:20:18 -07:00
Toshio Kuratomi
bf42f94021 Fixes to pip with git install instructions
* use git+https:// in the example url because not everyone will have ssh
  keys registered on github
* Remove the link to the github tarballs as they do not work.  users can
  use releases.ansible.com instead.
2017-07-26 16:28:42 -07:00
scottb
058e67dcbe Minor edits. 2017-07-26 10:50:01 -04:00
Brian Coca
74e9e4bcbd updated --diff docs 2017-07-26 10:50:01 -04:00
David Moreau-Simard
e2d874c744 Improve release and development cycle documentation
This commit:
- Adds a table highlighting the status of each version and provides
  a link to each major release's changelog
- Re-inforces how stable versions are maintained and for how long
- Moves this documentation out of the developer tree (this is
  interesting for users too!) while keeping a link there.
2017-07-25 23:38:08 -07:00
jokurz
732912b641 Add local_action example in case of multiple arguments (#26427)
* Add local_action example in case of multiple arguments

Add an example to show how local_action can be used in case of multiple arguments.

* Update playbooks_delegation.rst
2017-07-25 19:06:59 -07:00
Andrea Tartaglia
341cf290d3 Added become_exe and become_flags docs (#19554)
* Added become_exe and become_flags docs

* Minor edits
2017-07-25 18:59:57 -07:00
Martin Krizek
9c50933a80 docs: fix community meetings link (#27264) 2017-07-25 09:23:01 -04:00
Matt Davis
9986639681 various Windows/Azure roadmap updates 2017-07-24 08:32:54 -07:00
Abhijeet Kasurde
4fd7ab11ff Minor fix for typo - ismount to is_mount
Fix adds correction from ismount to is_mount filter in
playbooks_tests documentation.

Fixes: 27128

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
2017-07-24 08:56:46 -04:00
Sam Doran
dac519135d Change docs to reference BOTMETA.yml instead of MAINTAINERS.txt (#26912) 2017-07-21 17:51:02 -04:00
Sloane Hertel
7a8054812c updated roadmap (AWS) (#27011)
* update AWS roadmap

* Update ROADMAP_2_4.rst
2017-07-21 13:56:06 -07:00
Toshio Kuratomi
f4bb71c0df Update roadmap with python3 status (#27171) 2017-07-21 12:17:49 -07:00
Matt Clay
a53dabf664 Update testing progress on 2.4 roadmap. 2017-07-20 22:02:59 -07:00
Chris Alfonso
c19d25cf67 Updating network roadmap segment to reflect any changes we decided (#27057)
upon during our 2.4 dev cycle.
2017-07-20 08:22:19 -06:00
rgm
13e7e00706 Fix double-quote chars in passwordstore examples (#27084)
Also add link to passwordstore.org and correct a typo.
2017-07-20 12:29:29 +10:00
Serge Bishyr
7694fd6f9f #27045 fix installation guide via apt (ubuntu) (#27049)
* #27045 fix installation guide via apt (ubuntu)

* Update intro_installation.rst

Re-added apt-get update as it is needed to get the latest package index from ppa:ansible/ansible
2017-07-20 11:52:21 +10:00
Adrian Likins
33a2d72290 Update facts/vault roadmap items (#27082)
* Update facts/vault roadmap items
2017-07-19 18:44:51 -04:00
James Mighion
b8337ee9d3 New module aireos_command (#26769)
* Adding ciscowlc_command module and unit tests.

* Adding __init__.py for unit test.

* Fixing PEP8 W503.

* Renaming module from ciscowlc_command to aire_command.

* Renaming aire_command to aireos_command.
2017-07-19 23:14:52 +05:30