Refactor Schema and Schema Data Related Documentation #554
Conversation
bendbennett
force-pushed
the
bendbennett/issues-418
branch
from
4e77155
to
204fe1d
Compare
bendbennett
force-pushed
the
bendbennett/issues-418
branch
from
204fe1d
to
eb37997
Compare
bendbennett
force-pushed
the
bendbennett/issues-418
branch
from
eb37997
to
c8a7082
Compare
…e" into a separate page (#418)
…n "Getting Started" section (#418)
…providers - overview (#418)
…resources - overview (#418)
…resources - crud (#418)
…resources - import (#418)
…resources - plan modification (#418)
…resources - state upgraders (#418)
…data sources - overview (#418)
…attributes & blocks - attribute schema (#418)
…attributes & blocks - attribute types (#418)
…attributes & blocks - attribute fields (#418)
…attributes & blocks - default values (#418)
…attributes & blocks - force new (#418)
…attributes & blocks - validators predefined (#418)
…attributes & blocks - validators custom (#418)
…attributes & blocks - blocks (#418)
…attributes & blocks - blocks computed (#418)
…ing Data - Terraform Concepts"(#418)
…tarted - Code Walthrough" (#418)
Co-authored-by: Brian Flad <bflad417@gmail.com>
Co-authored-by: Brian Flad <bflad417@gmail.com>
…Handling Data - Blocks" page (#418)
| } | ||
| ``` | ||
|
|
||
| ## Blocks |
There was a problem hiding this comment.
For a followup PR, I think we should just include a quick summary here similar to the top of the blocks page, then link to that page for the rest. 👍
|
|
||
| The following examples use a resource but the same schema attribute and block types are also defined with the schema for providers and data sources. The examples focus on type-related information, the `Optional` field is included just to provide working examples but refer to Schema (add link) for information about the other fields that can be defined within attributes and blocks. | ||
|
|
||
| ## Attributes |
There was a problem hiding this comment.
Similarly in a followup for these, it might make sense to summarize that attributes set values and provide a quick table of descriptions -- leaving the nitty gritty details for the attributes page. 👍
website/docs/plugin/framework/handling-data/terraform-concepts.mdx
Outdated
Show resolved
Hide resolved
website/docs/plugin/framework/handling-data/terraform-concepts.mdx
Outdated
Show resolved
Hide resolved
| } | ||
| ``` | ||
|
|
||
| ## Custom Types |
There was a problem hiding this comment.
For a followup change, since this is a framework-defined concept and not a Terraform one, I'd suggest moving this to its own new page. 👍
website/docs/plugin/framework/getting-started/code-walkthrough.mdx
Outdated
Show resolved
Hide resolved
website/docs/plugin/framework/getting-started/code-walkthrough.mdx
Outdated
Show resolved
Hide resolved
website/docs/plugin/framework/getting-started/code-walkthrough.mdx
Outdated
Show resolved
Hide resolved
website/docs/plugin/framework/getting-started/code-walkthrough.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| ## Terraform Configuration | ||
|
|
||
| With the definitions we have for [provider server](#provider-server), [provider](#provider), [resource](#resource) and [data source](#data-source), we can run the provider by specifying configuration and executing `terraform apply`. |
There was a problem hiding this comment.
Not for right now, but I'm a little worried this may give the impression that the provider developer can just create a *.tf file with the below and it'll magically work. Not sure if it is worth adding words or pointing to other documentation to mention how to wire/publish things together fully.
Co-authored-by: Brian Flad <bflad417@gmail.com>
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Closes: #418
Closes: #485