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

Add documentation #2

Open
jbouse opened this issue Feb 25, 2021 · 3 comments
Open

Add documentation #2

jbouse opened this issue Feb 25, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jbouse
Copy link
Member

jbouse commented Feb 25, 2021

Nobody likes writing it but we should have some documentation to accompany this provider.

@jbouse jbouse transferred this issue from ugns/terraform-provider-bref-orig Feb 25, 2021
@jbouse jbouse added the documentation Improvements or additions to documentation label Feb 25, 2021
@jbouse jbouse self-assigned this Feb 25, 2021
@jbouse
Copy link
Member Author

jbouse commented Mar 2, 2021

New scaffolding imploys documentation generation but still needs to make sure everything is in place within code to properly generate the documentation.

@allan-simon
Copy link

interested if you have a little example on how to use it :)

@jbouse
Copy link
Member Author

jbouse commented Mar 26, 2021

interested if you have a little example on how to use it :)

@allan-simon I am still figuring out and learning myself how to use it. From hashicorp/terraform-plugin-docs I've followed the examples and what the hashicorp/terraform-provider-scaffolding scaffolding setup.

The best I've learned so far is that the examples/ content is used to create the docs/ content when executing go generate. The examples/ are used as just that within the documentation and the Description fields in the Schema declarations are used to generate the schema portion of the documentation.

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

No branches or pull requests

2 participants