ansible-collections / vmware.vmware

Ansible VMWare Collection
GNU General Public License v3.0
7 stars 10 forks source link

update readme format #62

Closed mikemorency closed 2 months ago

mikemorency commented 2 months ago
SUMMARY

Updating README format to match standard template described here https://access.redhat.com/articles/7068606

ISSUE TYPE
COMPONENT NAME

README.md

anna-savina commented 2 months ago

Maybe also worth adding Use Cases for content_template, folder_template_from_vm and vcsa_settings modules

mikemorency commented 2 months ago

Maybe also worth adding Use Cases for content_template, folder_template_from_vm and vcsa_settings modules

The example collections I saw had self-contained use cases, so someone could perform the entire use case with just this one collection. I think for those other modules, I would need to reference the community or vmware_rest collections. Let me see if I can find other examples of collections doing something similar

mikemorency commented 2 months ago

@anna-savina I couldnt find collections that had use cases referencing other collections. amazon.aws, which is in a similar situation to vmware.vmware, only includes modules from their collection. So i think we shouldnt add the other modules to the use cases yet

anna-savina commented 2 months ago

LGTM thank you!