Skip to content

Refactor Schema and Schema Data Related Documentation #418

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

Closed
bflad opened this issue Jul 18, 2022 · 3 comments · Fixed by #554
Closed

Refactor Schema and Schema Data Related Documentation #418

bflad opened this issue Jul 18, 2022 · 3 comments · Fixed by #554
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@bflad
Copy link
Contributor

bflad commented Jul 18, 2022

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:

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

@bflad bflad added the documentation Improvements or additions to documentation label Jul 18, 2022
@bflad
Copy link
Contributor Author

bflad commented Sep 13, 2022

This updated documentation should also contain a reference page for schema block support.

@bflad bflad added this to the v1.0.0 milestone Sep 13, 2022
bflad added a commit that referenced this issue Sep 30, 2022
…essing schema data

Reference: #498
Reference: #418
Reference: https://discuss.hashicorp.com/t/terraform-plan-does-not-allow-sending-only-delta-for-list-type-parameters-in-the-resource-block/45027
Reference: https://discuss.hashicorp.com/t/set-state-for-optional-nested-attributes-for-singlenestedattributes/44838/2
Reference: https://discuss.hashicorp.com/t/why-is-req-plan-get-in-my-create-method-throwing-an-error/44441/2
Reference: https://discuss.hashicorp.com/t/terraform-plugin-framework-value-conversion-error-unhandled-unknown-value/44382/3
... plenty more ...

The current recommendation is now to always use `types` package types, unless there is no chance for null/unknown values. The conversion rules sections will likely be further handled in #418 by having a schema conversion page that outlines how to map each framework-defined type into value types.
bflad added a commit that referenced this issue Oct 3, 2022
…essing schema data (#504)

Reference: #498
Reference: #418
Reference: https://discuss.hashicorp.com/t/terraform-plan-does-not-allow-sending-only-delta-for-list-type-parameters-in-the-resource-block/45027
Reference: https://discuss.hashicorp.com/t/set-state-for-optional-nested-attributes-for-singlenestedattributes/44838/2
Reference: https://discuss.hashicorp.com/t/why-is-req-plan-get-in-my-create-method-throwing-an-error/44441/2
Reference: https://discuss.hashicorp.com/t/terraform-plugin-framework-value-conversion-error-unhandled-unknown-value/44382/3
... plenty more ...

The current recommendation is now to always use `types` package types, unless there is no chance for null/unknown values. The conversion rules sections will likely be further handled in #418 by having a schema conversion page that outlines how to map each framework-defined type into value types.
@bflad
Copy link
Contributor Author

bflad commented Oct 25, 2022

The updated documentation should also contain complex data modeling and provider logic (e.g. nested lists, nested attributes)

bendbennett added a commit that referenced this issue Dec 6, 2022
bendbennett added a commit that referenced this issue Dec 6, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 8, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
…attributes & blocks - validators predefined (#418)
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 9, 2022
bendbennett added a commit that referenced this issue Dec 12, 2022
bendbennett added a commit that referenced this issue Dec 12, 2022
bendbennett added a commit that referenced this issue Dec 13, 2022
bendbennett added a commit that referenced this issue Dec 13, 2022
@github-actions
Copy link

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 13, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants