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

Code example not consumed in docs generation #242

Closed
Tracked by #217
stirby opened this issue Jun 24, 2024 · 2 comments · Fixed by #243
Closed
Tracked by #217

Code example not consumed in docs generation #242

stirby opened this issue Jun 24, 2024 · 2 comments · Fixed by #243
Assignees
Labels
docs Improvements or additions to documentation

Comments

@stirby
Copy link
Contributor

stirby commented Jun 24, 2024

All of our resources and data sources should have code examples. While some are missing entirely, coder_parameter has an example which does not appear in the documentation.

Possibly an issue with the tfplugindocs generation call.

coder_parameter is the only resource or data source with an example that doesn't propagate to the docs.

@stirby stirby changed the title Code examples not consumed in docs generation Code example not consumed in docs generation Jun 24, 2024
@coder-labeler coder-labeler bot added the docs Improvements or additions to documentation label Jun 24, 2024
@stirby stirby self-assigned this Jun 24, 2024
@stirby
Copy link
Contributor Author

stirby commented Jun 24, 2024

Pathing issue, not a problem with Docs generation. I'll fix this.

@stirby
Copy link
Contributor Author

stirby commented Jun 24, 2024

coder_workspace_tags also subject.

Interestingly, they are the only examples prefixed with:

provider "coder" {}

...

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

Successfully merging a pull request may close this issue.

1 participant