Skip to content
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

Migrate hand crafted documentation to auto generated tfplugindocs #256

Closed
16 tasks done
ddelnano opened this issue Aug 21, 2023 · 1 comment
Closed
16 tasks done

Migrate hand crafted documentation to auto generated tfplugindocs #256

ddelnano opened this issue Aug 21, 2023 · 1 comment

Comments

@ddelnano
Copy link
Collaborator

ddelnano commented Aug 21, 2023

The hashicorp/terraform-plugin-docs makes it easy to define your terraform provider's documentation inline with the resource and data source code. The newer resources such as xenorchestra_network and xenorchestra_bonded_network were created with this already, but all of the existing resources and data sources must be migrated to it.

The following list tracks the remaining work to complete this migration:

  • xenorchestra_vm
  • xenorchestra_vdi
  • xenorchestra_acl
  • xenorchestra_cloud_config
  • data source vms
  • data source vdi
  • data source user
  • data source template
  • data source sr
  • data source resource_set
  • data source pool
  • data source pif
  • data source network
  • data source hosts
  • data source host
  • data source cloud_config
@ddelnano
Copy link
Collaborator Author

ddelnano commented Sep 8, 2023

The next release of the provider will include the majority of the migration. The vm resource and data source are blocked behind the migration to the terraform-plugin-framework due to hashicorp/terraform-plugin-docs#64 (comment).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant