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

Investigate generation of the documentation #57

Open
kvrhdn opened this issue Mar 25, 2021 · 4 comments
Open

Investigate generation of the documentation #57

kvrhdn opened this issue Mar 25, 2021 · 4 comments
Labels
improvement refactor Internal improvements.
Projects
Milestone

Comments

@kvrhdn
Copy link
Contributor

kvrhdn commented Mar 25, 2021

It's apparently already possible to generate documentation based upon the various Description fields within the resource definitions.

To do:

  • investigate how we get this working
  • verify whether it can replace the current documentation

Links
https://github.com/hashicorp/terraform-plugin-docs
https://github.com/hashicorp/terraform-provider-scaffolding/blob/main/main.go#L20

@kvrhdn kvrhdn added the refactor Internal improvements. label Mar 25, 2021
@kvrhdn kvrhdn added this to Backlog / ideas in Activity via automation Mar 25, 2021
@kvrhdn kvrhdn moved this from Backlog / ideas to To do in Activity Mar 25, 2021
@jharley jharley moved this from To do to Backlog / ideas in Activity Jan 28, 2022
@jharley jharley moved this from Backlog / ideas to To do in Activity Feb 1, 2022
@ryanking
Copy link

I have done this before for the snowflake provider and would be happy to contribute a PR. Ok?

@jharley
Copy link
Collaborator

jharley commented May 16, 2022

@ryanking I would love it!

@dstrelau
Copy link
Member

Full auto-generated documentation now exists in the registry.

@jharley jharley reopened this Nov 16, 2023
@jharley
Copy link
Collaborator

jharley commented Nov 16, 2023

Miscommunication here: this is sadly still not true, I hope to get it done in the next few months.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement refactor Internal improvements.
Projects
No open projects
Development

No branches or pull requests

4 participants