Update to Roles Documentation main.yml Minimum Requirements

[chynasan]

Galaxy and AutomationHub use roles/meta/main.yml to generate the description field for roles.

It's recently surfaced that the minimum required parameters for a meta/main.yml file seem to be:

galaxy_info:
  description: Generates Output folders for arista.avd collection.
  standalone: false

Using these parameters allows ansible-lint to still pass, and seems to fulfill the requirements for role metadata population in Galaxy/AutomationHub.

While many of our partners do use additional roles and fields successfully, the documentation at ansible-documentation/docs/docsite/rst/playbook_guide/playbooks_reuse_roles.rst does not specify what the actual minimum required parameters are for meta/main.yml. Is this something worth considering adding to the documentation to make it easier for collections developers to know what to configure?

[ansible-documentation-bot[bot]]

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

[oraNod]

Thanks for the issue @chynasan This seems related to #1241 and, to answer your question, worthy of consideration in the docs imo. Feel free to go ahead and submit a PR with the doc changes if you're so inclined. You can also join us on Matrix in the docs channel if you have more questions or want to chat it out. Cheers.

[samccann]

Discussed in the DaWGS meeting:

• We need to discover what Galaxy requires. AH requirements should be covered by Red Hat official docs (tho if folks know the details, add to this issue and we can pass on to the correct team)
• Need to decide where to put this info in our docs, since roles don't require this for local use, only for being shared in Galaxy.

[samccann]

Discussion started - https://forum.ansible.com/t/does-galaxy-importer-need-its-own-documentation/4979