documentation: generate docs from provider schemas #248
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This pull request has been linked to Shortcut Story #62363: terraform provider: improve documentation. |
sauterp
force-pushed
the
sauterp/sc-62363/improve-docs
branch
from
1bfe744
to
56c473b
Compare
sauterp
commented
Feb 27, 2023
Comment on lines
+70
to
+96
| <a id="nestedatt--instances"></a> | ||
| ### Nested Schema for `instances` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `anti_affinity_group_ids` (Set of String) | ||
| - `created_at` (String) | ||
| - `deploy_target_id` (String) | ||
| - `disk_size` (Number) | ||
| - `elastic_ip_ids` (Set of String) | ||
| - `id` (String) | ||
| - `ipv6` (Boolean) | ||
| - `ipv6_address` (String) | ||
| - `labels` (Map of String) | ||
| - `manager_id` (String) | ||
| - `manager_type` (String) | ||
| - `name` (String) | ||
| - `private_network_ids` (Set of String) | ||
| - `public_ip_address` (String) | ||
| - `reverse_dns` (String) | ||
| - `security_group_ids` (Set of String) | ||
| - `ssh_key` (String) | ||
| - `state` (String) | ||
| - `template_id` (String) | ||
| - `type` (String) | ||
| - `user_data` (String) | ||
| - `zone` (String) |
There was a problem hiding this comment.
Notice that for a nested list of objects the plugin generating the docs doesn't include the descriptions. This is unfortunately an issue we can't do much about:
hashicorp/terraform-plugin-docs#28 (comment)
kobajagi
approved these changes
Feb 27, 2023
jessicatoscani
approved these changes
Feb 28, 2023
PhilippeChepy
approved these changes
Feb 28, 2023
sauterp
force-pushed
the
sauterp/sc-62363/improve-docs
branch
from
92f70e6
to
bdbcdd2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We make use of tfplugindocs and refacor the codebase so that all documentation files are generated from the schemas in the source code. To ensure that developers don't forget to update the documentation in the future we add a CI step that verifies that the generated documentation matches the docs checked into git.
Additionally we add an indicator to the documentation description of each attribute for which
ForceNew == true.