Skip to content
This repository has been archived by the owner on Sep 6, 2023. It is now read-only.

Generating provider documentation #15

Closed
wants to merge 2 commits into from
Closed

Generating provider documentation #15

wants to merge 2 commits into from

Conversation

t0mk
Copy link
Contributor

@t0mk t0mk commented Dec 23, 2020

This is work on generating docs with https://github.com/hashicorp/terraform-plugin-docs

I started with resource metal_volume as an example of how it could look, relevant diff in 2de103c

fixes equinix/terraform-provider-equinix#201

(it was necessary to update tf-plugin-sdk, maybe I could do it in a separate PR, in order to get better PR diff for review)

@displague
Copy link
Member

displague commented Dec 23, 2020

Have a look at this thread, tinkerbell/terraform-provider-tinkerbell#20 (comment) and this commit tinkerbell/terraform-provider-tinkerbell@1d2377d.

I think this provides a cleaner approach to introducing this bit of tooling without adding dozens of new requirements.

@t0mk
Copy link
Contributor Author

t0mk commented Dec 23, 2020

@displague thanks, I will take a look

@ocobles
Copy link
Contributor

ocobles commented Jun 21, 2022

The issue linked to this PR has been transferred to equinix/terraform-provider-equinix: equinix/terraform-provider-equinix#201

This draft is outdated (vendor folder removed, go sdk version updated, docs md files renamed), and according to the conversation in this thread tools.go approach must be replaced with go.tools.mo. Therefore, the migration to the new provider repository introduces more complexity than a fresh start.

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

Successfully merging this pull request may close these issues.

Generate docs with go generator
3 participants