-
Notifications
You must be signed in to change notification settings - Fork 99
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
Module version
v0.10.0
Use-cases
The website documentation is less than ideal as it has quite a few schema-related pages as top-level in the lengthy side navigation. In particular:
- https://terraform.io/plugin/framework/accessing-values
- https://terraform.io/plugin/framework/paths
- https://terraform.io/plugin/framework/path-expressions
- https://terraform.io/plugin/framework/schemas
- https://terraform.io/plugin/framework/writing-state
It would be clearer if these were bundled together as they are conceptually related.
Proposal
Create a new top-level section named "Schemas and Schema Data" or "Schemas and Config/Plan/State" with the following:
- Overview page, brief introduction to the concepts and linking to others
- Redirected accessing values page
- Redirected paths page
- Redirected path expressions page
- Redirected schemas page (maybe "Schema Definitions"?)
- Redirected writing state page (probably should not say state as it also related to setting the plan in plan modifiers)
Doing this will likely warrant fixing wording/flow for all the concepts/pages to ensure they seem cohesive together.
References
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation