* clarify no subfolders and md only for collections /docs folder (#63808)
(cherry picked from commit 6a2902c8d5)
* Fixed example error in windows_winrm user guide (#63922)
The example code to configure TLS 1.2 Support using Ansible had an indention error. The register variable 'enable_tls12' was not indented. This caused the subsequent task to fail since the variable was not registered.
(cherry picked from commit c562e17659)
* Fix doc errors in AWS modules (#63851)
* Fix register/debug in aws_batch_compute_environment
* Fix aws_batch_job_queue doc errors
* Fix module naming: `batch_job_queue` > `aws_batch_job_queue`
* Fix missing register
* Update debug task to use modern YAML format
* Fix missing register + debug for lambda_policy
* Fix YAML syntax for elb_application_lb_info module
(cherry picked from commit e4f16368ed)
* Update documentation for package module (#63909)
It is not clear from the documentation that list can be used
(cherry picked from commit 7f2c367d78)
* [ec2_launch_template] Update description of state param (#63147)
Currently, it is not possible to delete specific versions of an ec2 launch template. The module docs incorrectly suggest that there is a `version` param to the module that can be used to do that. This patch aims to correct that error.
(cherry picked from commit 7ea7260753)
* template: Add a space in example block (#63930)
(cherry picked from commit f279715c29)
* revisions to docsite README (#63957)
(cherry picked from commit 5c962ef859)
* combine galaxy.com install roles details (#63486)
(cherry picked from commit ee8a088205)
* Correct a typo (#64020)
(cherry picked from commit 18f4f0549f)
* Update password.py (#63965)
Update the examples of the password lookup plugin to show how multiple options are joined together.
(cherry picked from commit 92daec5d0b)
* Fix indentation of example (#63789)
Remove no_log since module_defaults aren't displayed like set_fact was
(cherry picked from commit 1e52782d6b)
* add newline to render table correctly (#63769)
(cherry picked from commit 1aee11c860)
* clarified some points on environment keyword usage (#64065)
(cherry picked from commit 885ee62b53)
* Replaced old DSC links that given 404 (#63556)
Replace DSC links that returned "not found" with updated, working links.
(cherry picked from commit f638f29e44)
* Fix example in pip module documentation (#63462)
(cherry picked from commit d8b9f9fb4f)
* Update vmware ansible modules requirements section (#62797)
Update vSphere Automation Python SDK to the requirement section
Signed-off-by: Jobin George <jgeorge@vmware.com>
Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit 8a77f17dea)
* Typo usersername should be username (#63671)
(cherry picked from commit 2ef4ac1404)
* Update description for firstmatch option (#62896)
Fixes issue https://github.com/ansible/ansible/issues/62862. The edit makes the description for the `firstmatch` option clearer. The `firstmatch` option was introduced by PR https://github.com/ansible/ansible/pull/33825
(cherry picked from commit aeb0dde7cc)
* Update win_regmerge.py (#63633)
s/windows/Windows/ in title
(cherry picked from commit 4326165be5)
* Example incorrect: server_url is required argument (#63670)
The example "Delete GitLab Group" does not work - requires server_url parameter. This likely applies to all Examples, so this change proposes at least putting in the required parameter in the examples. In future we can remove the soon-to-be deprecated server_url parameter.
(cherry picked from commit b02467961a)
* doc: win_user: fix typo in the description of the groups modifyer (#63743)
(cherry picked from commit 6046386dba)
* Update AWS dev guide to recommend module_defaults and point to CI policy repo (#63589)
(cherry picked from commit 9cda5819b9)
* Add example for port range to win_firewall_rule_module (#63269)
(cherry picked from commit 2e81b813dd)
* added a link to install instruction of OpenSSH (#63548)
(cherry picked from commit cfe2beae46)
* Update sros_config.py (#63132)
(cherry picked from commit b3deab4319)
* add note about collection links (#63346)
(cherry picked from commit bdd0fac606)
* Nosh module documentation update (#63303)
* detail the 'status' dictionary
* did not add individual descriptions, see nosh documentation for those
* sample: False not being rendered unless 'False' is quoted
(cherry picked from commit df283788e5)
* Move galaxy appendix info to a new Galaxy section (#63356)
* start galaxy docs restructure
* shared snippets in txt files
* moved all content to galaxy section
(cherry picked from commit ae265bc546)
* Enter should be Italics as it is a menu option (#63441)
(cherry picked from commit 7a8c909876)
* ini_file: remove incorrect documentation (#63394)
(cherry picked from commit ab249a469e)
* Changed with_items to loop in VMware example (#63022)
(cherry picked from commit 876a2d57be)
* ovirt update fetch_nested param doc (#63191)
(cherry picked from commit 0beab6bf69)
* Update 'delete' parameter description in synchronize module (#63450)
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
(cherry picked from commit da46800f1b)
* Update unarchive.py - Further clarify extra_opts (#58102)
Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options.
Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
(cherry picked from commit e967060b9f)
* ovirt_vm add warning about next run configuration (#63458)
(cherry picked from commit 16e49fdd44)
* Fix doc - porting_guide_2.8 value example (#63493)
(cherry picked from commit e0f67b58ce)
* Fix warnings for ufw examples (#63505)
(cherry picked from commit e4eea0510c)
* Update stat.py (#63289)
Reword awkward documentation language.
(cherry picked from commit b46299ff86)
* Update win_disk_facts.py example (#63266)
Fix incorrect index for second disk (should be `disks[1]` not `disks[0]`)
(cherry picked from commit ce1c8c24f7)
* Fix broken link (#63185)
(cherry picked from commit 021d095625)
* Typo on line 161 (#63133)
fix module name for azure_rm_manageddisk in one example
(cherry picked from commit 81a614684a)
* docs: add Centos and Ubuntu to examples for playbook conditionals (#63085)
Co-Authored-By: Sandra McCann <samccann@redhat.com>
(cherry picked from commit 19587b35da)
* Spot instance code error (#63246)
Adds 'instance_initiated_shutdown_behavior: terminate' to spot instance example for greater efficiency.
(cherry picked from commit 5ed163ce3f)
* Pass a JSON file to the Lambda's payload (#63261)
* Add an example of passing a JSON file to the Lambda's payload
Events passed to Lambda are commonly in JSON format, the change provides an example of using JSON file as an alternative to the inline YAML payload in the other examples.
(cherry picked from commit 1d5206f53e)
* Update ec2.py (#63260)
Change the explanation of spot_wait_timeout
(cherry picked from commit 719170e5c1)
* fix aruba_config examples (#63136)
(cherry picked from commit 6ff5968781)
* [ec2_launch_template] Update examples (#63152)
- Update tasks names for existing examples
- Add a new example showing how to delete a launch template
(cherry picked from commit 32980f214a)
* add more anchors to collections docs (#62827)
(cherry picked from commit 7e01de96d7)
* add anchors to support galaxy links (#62808)
(cherry picked from commit 1b3bf33bdf)
* doc: fix typos (#62852)
(cherry picked from commit b33ae14949)
* Add some documentation about using plugins in collections (#62465)
- FQCN requirements
- Sharing code in collections
- Limitations with inventory caching
(cherry picked from commit d41050b28b)
* Remove Latin phrases from the docs (#62419)
* add styleguide about avoiding use of latin words
(cherry picked from commit e7436e278f)
* ovirt: Fixing typo in ovirt_disk examples (#62962)
(cherry picked from commit 50dc41cca2)
* vmware guidlines: adjust the location of cloud-config-vcenter.ini.template (#62970)
Update the location of the cloud-config-vcenter.ini.template template.
The file has been moved by: 2e7d36a3f9.
(cherry picked from commit 7ecfa4a471)
* Prefer https:// links in the docs site (#62939)
This is a follow-up of last year's 1a11cec. It deals with links which
at that point either were not present or did not support https://.
(cherry picked from commit c8315bfd60)
* fix minor typos (#62950)
(cherry picked from commit ad580a71c4)
* Modernize Vagrant documentation (#62923)
* By requiring a slightly newer Vagrant version (from 2015) we get the
same generated Ansible inventory format is still used by today's
version of Vagrant. That extended inventory format also has the
benefit of allowing for simpler Ansible examples.
* Switching to a current and supported Ubuntu LTS version.
(cherry picked from commit 0d79013f51)
* add ios/iosxr deprecated modules (#62908)
(cherry picked from commit 6bbd9c9eca)
* Update pip module docs (#62359)
* Clarifying pip module requirements in reference to #47361
* Further clarifying message with link to ansible_python_interpreter
(cherry picked from commit d3ec5ca80f)
* chore/doc-module: sts_assume_role.py (#62475)
Update `Example` section with with the correct module usage.
(cherry picked from commit a4a216640f)
* Improve dconf documentation to include conversion problems (#62316)
(cherry picked from commit 864928365e)
* Add examples for various inventory setups to the documentation (#62323)
* Updates docs/docsite/rst/user_guide/intro_inventory.rst, closes#12480.
* Use code-block and rename groups in inventory setup examples
* Fix group name in inventory setup example
Co-Authored-By: Sandra McCann <samccann@redhat.com>
(cherry picked from commit 7047b66d34)
* added networking porting guide info (#61999)
* Update docs/docsite/rst/porting_guides/porting_guide_2.9.rst
Co-Authored-By: Nathaniel Case <this.is@nathanielca.se>
(cherry picked from commit 6d35f9026f)
* [docs] split collections into user and dev guide sections (#62363)
(cherry picked from commit 7badeb6df0)
* fixed options (#62605)
(cherry picked from commit 170b4e63ff)
* ec2_vpc_subnet: Rename resource_tags > tags (#62663)
Most of the AWS module documentation refers to `tags` and not
`resource_tags`. This patch updates the documentation to match
other AWS module documentation. 😉
Signed-off-by: Major Hayden <major@redhat.com>
(cherry picked from commit cced1a3cd1)
* [Docs] Document the resource module builder (#62222)
(cherry picked from commit b17581a307)
* Fix link syntax and a typo in dev collections doc (#62650)
(cherry picked from commit 2969614c2c)
* hcloud_volume: clarify volume size units (#62771)
(cherry picked from commit 190b8fcd1c)
* ovirt_host update force doc (#62491)
(cherry picked from commit 3b2b418aad)
* update example document for zabbix_action module (#62667)
(cherry picked from commit 3299f29f7c)
Add information and examples on how to use additional properties from a doc fragment
Add info about layering properties
(cherry picked from commit 9b348e690c)
(cherry picked from commit 5deb01c84d)
(cherry picked from commit 041c52d629)
* Change collection PS util import pattern
* Add changes for py2 compat
* fix up regex and doc errors
* fix up import analysis
* Sanity fix for 2.6 CI workers
* Get collection util path for coverage collection
* ansible-galaxy: support multiple servers on install
* Added docs for the server configuration file
* Fix up doc string for requirements file format
* Fix bugs after testing
* Fix kwarg doc and added version
* Fix typo and doc improvement
* Fix base64 encoding and allow --server to override list
* Add writing new tests subsection to vmware_guidelines
Specifically address use of the prepare_vmware_tests role
Point to common vars for use by test writers
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
This will help prevent accidental merging of content to recently obsoleted directories when adding new files.
It may also help contributors who have modified obsolete files understand where their changes should now be made.
* Relocate module validator code and tests.
* Fix validate-modules entry point and imports.
* Fix paths and test entry points.
* Fix up unit tests.
* Fix shebang and execute bit.
* Relocate ansible-only sanity tests.
* Get "code smell" sanity tests from multiple dirs.
- `test/lib/ansible_test/_data/sanity/code-smell/` - General purpose tests used for both Ansible and Ansible Collections.
- `test/sanity/code-smell/` - Tests specific to Ansible, will not be used for Ansible Collections.
* Render elements in module doc and sanity test for suboptions
* Add support to render module elements value in ansible-doc output
module html
* Add validate-module sanity test of sunoptions.
* Add current validate module failures to ignore list
* Fix CI failure
* fix rebase conflict
* Fix CI issues
* Fix review comments
* Add validate-modules failure in ignore list
- Use predictable VM name during the tests (test_vm1, test_vm2 and
test_vm2). This to simplify the teardown of the newly created resource
before the next test.
- Update the documentation to explain the new requirement
- Avoid VM creation with `with_items` when it's not mandatory. This to:
- speed up the test execution, our hypervisors have limited resources
- simplify the teardown
- Remove `create_d1_c1_f0_env.yml`, the test was just testing how Ansible
pass environment variables.
- Correct the name for the `f0` variable (`f1`)
- Fix the DVS tests, the hosts can now reach the dvswitch1 vswitch
- Provision the VM with a poweroff status, this to improve the
idempotency and sleep up the tests
- Avoid the use of `prepare_vmware_tests` to prepare virtual machines
when we just need one machine
* Add sanity test to ensure all non-py files are installed
* Fix mode and regex
* Fix role skel inventory package_data
* Add docs
* Update package_data for inventory files
* Address pylint concerns
* Another tweak to package_data
* Address review feedback
* Change index to 1
* add to ansible-only.txt
* Generate galaxy.yml based on single source of truth
* Fix up tests and align file names
* Minor Makefile tweak
* Remove link in galaxy.yml file and make it a template file
* Moved collections docs to dev_guide
* change Makefile clean path
* Added readme to example meta file
* review fixes
* Use newer style for doc generation script
* Fix mistake in dev_guide index
* removed uneeded file, fixed links and added preview banner
* Moved banner for sanity test
Alicia Cozine