-
Notifications
You must be signed in to change notification settings - Fork 78
Add support for generating docs for list-resources #528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good! Left some notes around documentation/tests and a question about migrate and the example files. Also we should add changelog before we merge this 🚀
internal/provider/testdata/test-list-resource-dir/list-resource.tf
Outdated
Show resolved
Hide resolved
cmd/tfplugindocs/testdata/scripts/schema-json/migrate/time_provider_success_docs_website.txtar
Outdated
Show resolved
Hide resolved
cmd/tfplugindocs/testdata/scripts/schema-json/migrate/time_provider_success_docs_website.txtar
Show resolved
Hide resolved
...lugindocs/testdata/scripts/schema-json/generate/framework_provider_success_legacy_docs.txtar
Outdated
Show resolved
Hide resolved
...ugindocs/testdata/scripts/schema-json/generate/framework_provider_success_static_files.txtar
Outdated
Show resolved
Hide resolved
...scripts/schema-json/generate/framework_provider_success_no_templates_multiple_examples.txtar
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 🚀
Description
This PR adds support for generating, migrating and validating docs for list-resources.
An example of what the generated docs look like can be found here austinvalle/terraform-provider-bufo@b7d799a
Rollback Plan
Changes to Security Controls
Are there any changes to security controls (access controls, encryption, logging) in this pull request? If so, explain.
None.