Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Replace old doc generation process with new tfplugindocs tool #356
Replace old doc generation process with new tfplugindocs tool #356
Changes from all commits
5bba9f9
75b4ea2
70f9c66
7380124
1766d34
2671c9f
d3cb7dc
7776fc2
00f2482
b2efacb
cb89c5b
9b921d6
0433b0a
7ea6eb7
1e8578b
e10374e
2222721
9862c36
4d430d3
8d8c755
4b21af5
bce4f8c
fbeb568
4b08c33
2fa9408
a9139cc
5d56048
ed6d11d
7fc608d
0e93c3a
f370999
4390d1f
8c7faa2
26dac20
d96f2a9
4f15842
65b6051
b454bb4
43b1655
fad370a
edc75bf
d120a09
0ac5ebe
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is currently some overlap between our own curated "Attributes Reference" and the "Schema" section generated dynamically by the new
tfplugindocs
tool, but until the issue (hashicorp/terraform-plugin-docs#28) is resolved we might want to hold off making any further content changes.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After discussing with @phamann I've decided I'm going to review each individual file and manually decide whether the curated content should stay or go. This is because some of the generated documentation files have dynamically generated Schema data that is very good and ends up making our own "Arguments Reference" and "Attributes Reference" sections completely redundant (i.e. lots of duplication).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few issues open already with the
tfplugindocs
tool only just being release. I've opened an issue related to nested Schema 'Description' fields not being included in the output.hashicorp/terraform-plugin-docs#28