Commit 0d47215
authored
Minor improvements to Framework and SDKv2 List Docs (#1494)
### What
- Framework's list documentation on non-framework resources links to a
more complete example in the SDKv2 documentation
- SDKv2's list documentation received some minor fixes in the example as
well as further comments and explicit imports to reduce confusion
----------
### Merge Checklist
_If items do not apply to your changes, add (N/A) and mark them as
complete._
#### Pull Request
- [ ] Description links to related pull requests or issues, if any.
#### Content
- [ ] You added redirects to
`content/terraform-docs-common/redirects.jsonc` for moved, renamed, or
deleted pages **across all affected versions**. Refer to
[Redirects](https://github.com/hashicorp/web-unified-docs/blob/main/docs/content-guide/redirects.md#example-redirects)
for examples and guidance.
- [ ] Links to related content where appropriate (e.g., CLI, language,
API endpoints, permissions, etc.).
- [ ] Pages with related content are updated and link to this content
when appropriate.
- [ ] Sidebar navigation files have been updated for added, deleted,
reordered, or renamed pages.
- [ ] New pages have metadata (page name and description) at the top.
- [ ] New images are 2048 px wide. They have HashiCorp standard
annotation color (#F92672) and format (rectangle with rounded corners),
blurred sensitive details (e.g. credentials, usernames, user icons), and
descriptive alt text in the markdown for accessibility.
- [ ] New code blocks have the correct syntax and line breaks to
eliminate horizontal scroll bars.
- [ ] UI elements (button names, page names, etc.) are bolded.
- [ ] The Vercel website preview successfully deployed.
#### Reviews
- [ ] I or someone else reviewed the content for technical accuracy.
- [ ] I or someone else reviewed the content for typos, punctuation,
spelling, and grammar.File tree
2 files changed
+15
-3
lines changed- content
- terraform-plugin-framework/v1.16.x/docs/plugin/framework/list-resources
- terraform-plugin-sdk/v2.38.x/docs/plugin/sdkv2/resources
2 files changed
+15
-3
lines changedLines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
39 | | - | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
Lines changed: 12 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
52 | 52 | | |
53 | 53 | | |
54 | 54 | | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
55 | 63 | | |
56 | 64 | | |
57 | 65 | | |
58 | 66 | | |
59 | 67 | | |
60 | 68 | | |
61 | 69 | | |
| 70 | + | |
62 | 71 | | |
63 | 72 | | |
64 | 73 | | |
| |||
69 | 78 | | |
70 | 79 | | |
71 | 80 | | |
72 | | - | |
73 | | - | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
74 | 84 | | |
75 | 85 | | |
76 | 86 | | |
| |||
0 commit comments