Use tfplugindocs to generate the provider documentation
#258
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dom Del Nano <[email protected]>
Signed-off-by: Dom Del Nano <[email protected]>
Signed-off-by: Dom Del Nano <[email protected]>
…actor host data source cpus description
Signed-off-by: Dom Del Nano <[email protected]>
…ons and add examples Signed-off-by: Dom Del Nano <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR updates the provider to use
tfplugindocsfor generating the project's documentation and addresses the vast #256.This fixes errors found in the docs and upgrades the examples to use the modern HCL syntax. All of the resources and data sources have been migrated to the generated versions with the exception of the
xenorchestra_vmresource andxenorchestra_vmsdata source. These entities contain large nested objects and until the provider is upgraded to use the terraform-plugin-framework the nested objects will have their description omitted (due to hashicorp/terraform-plugin-docs#64 (comment)). That work will be tracked in #256.Test plan