-
Notifications
You must be signed in to change notification settings - Fork 45
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
Generate docs with go generator #201
Comments
I have just tried However, to take full advantage of
|
The drafts pull request equinix/terraform-provider-metal#15 and equinix/terraform-provider-metal#132 created at equinix/terraform-provider-metal have been closed without resolution due to the complexity of migrating that work to this repository. Any related work must be recreated. Relevant information from the conversation is linked below: equinix/terraform-provider-metal#15 (comment)
|
The provider will likely need to adopt documentation generation in a major version release, because we cannot generate docs in the current structure where files are prefix with Rather than fork the generator or do extra workarounds to rename files after generation, we should align with the standards that are implemented by the generator and that are used by other providers; that means breaking existing docs pages because there's no way to redirect those old URLs. |
It is now possible to generate provider docs using the https://www.terraform.io/docs/registry/providers/docs.html#generating-documentation generator and fields embedded in the provider.
Can we generate all of our documentation identically in this way?
The generator is noted to have some weakness handling deep structures.
Some example repositories using this method:
The text was updated successfully, but these errors were encountered: