Right now if someone wants to know all the supported resources from an specific cloud provider they have to go to https://github.com/cycloidio/terracognita/blob/master/aws/resources.go#L38 or run terracognita {PROVIDER} resources. Would be good to have another place which is not code related to get that information.
Proposal
Autogenerate a file under docs/ with that list for each cloud provider and add the link to the README where we mention the providers we support so the list of resources would be easy accessible.
Implementation
Having an internal cli that with //go:generate will parse the Resources and generate a documentation with all of the resources for all the providers we support.
Abstract
Right now if someone wants to know all the supported resources from an specific cloud provider they have to go to https://github.com/cycloidio/terracognita/blob/master/aws/resources.go#L38 or run
terracognita {PROVIDER} resources
. Would be good to have another place which is not code related to get that information.Proposal
Autogenerate a file under
docs/
with that list for each cloud provider and add the link to the README where we mention the providers we support so the list of resources would be easy accessible.Implementation
Having an internal cli that with
//go:generate
will parse the Resources and generate a documentation with all of the resources for all the providers we support.Open issues (if applicable)