ansible-collections / amazon.cloud

Ansible Collection for Amazon AWS' Cloud Control API
GNU General Public License v3.0
12 stars 12 forks source link

modules missing examples #63

Open samccann opened 1 year ago

samccann commented 1 year ago

Summary

Someone pointed out that the modules/plugins don't have examples listed.

Issue Type

Documentation Report

Component Name

autoscaling_launch_configuration.py

Ansible Version

$ ansible --version

Collection Versions

$ ansible-galaxy collection list

Configuration

$ ansible-config dump --only-changed

OS / Environment

No response

Additional Information

No response

Code of Conduct

alinabuzachis commented 1 year ago

@samccann Thank you for raising this issue. This collection is auto-generated using the https://github.com/ansible-community/ansible.content_builder. EXAMPLES block is filled using the integration tests examples. In this collection, not all the modules are covered by integration tests and which is why some are lacking examples.

samccann commented 1 year ago

Thanks for the explanation @alinabuzachis . FYI - we've got some customer feedback on another collection (vmware_rest) that suggests integration tests as examples aren't always helpful (aka seen as less real-world than if someone hand-crafted the examples to match a real-world use case). Still in discussion but wanted to share that bit of early feedback.

alinabuzachis commented 1 year ago

@samccann The vmware.vmware_rest collection is also auto-generated using the https://github.com/ansible-community/ansible.content_builder. Also in this case, EXAMPLES blocks are populated using tasks coming from the integration tests.