ansible-community / ansible.content_builder

A collection to scaffold Ansible plugins.
GNU General Public License v3.0
31 stars 27 forks source link

Enhancement: examples generated for each of the scaffolded content types and their source. #49

Open netopsengineer opened 1 year ago

netopsengineer commented 1 year ago
SUMMARY

As someone new to writing plugins, filters, or modules, it would be helpful to see hello world style examples generated of each scaffolded type, and their source.

ISSUE TYPE
COMPONENT NAME

build.yaml

ADDITIONAL INFORMATION

Source directories with the items required in the manifest.yaml, such as the docstring.yaml, so the expected inputs/outputs can be reviewed.

A readme with how one even created the Collection to start with, that you must provide the path, namespace, and name to in manifest.yaml, as you likely have not created a Collection, if you are coming here to use a Collection to get started building these more advanced content types. Essentially, more getting started friendly docs, and examples for modules, filters, and plugins, similar to the newly added docs, and examples for resource_module scaffolding.

I think this Collection is awesome for creating consistent content with best practices, but the barrier to entry is a little steep for beginners in the custom content area of the Ansible ecosystem.

By the way, the importing of OpenAPI spec to create a resource_module is brilliant, well done folks!

tlourey commented 8 months ago

Totally agree.