Skip to content
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

website: Expand data handling documentation with type-specific pages and examples #822

Merged
merged 9 commits into from
Aug 17, 2023

Conversation

bflad
Copy link
Contributor

@bflad bflad commented Aug 15, 2023

Closes #695

This change creates new attributes, blocks, and types sections, each with full information about each type. The attribute/block pages are cross-linked with their associated type pages and vice-versa.

Web platform changes to redirect the removed pages to existing pages will be handled separately on deployment.

…and examples

Reference: #695

This change creates new attributes, blocks, and types sections, each with full information about each type. The attribute/block pages are cross-linked with their associated type pages and vice-versa.

Web platform changes to redirect the removed pages to existing pages will be handled separately on deployment.
@bflad bflad added the documentation Improvements or additions to documentation label Aug 15, 2023
@bflad bflad requested a review from a team as a code owner August 15, 2023 13:20
Mainly to appease the web platform content checking:

```
Found mismatched paths at depth 2, with paths: ["handling-data/types","handling-data/types/bool","handling-data/types/float64","handling-data/types/int64","handling-data/types/list","handling-data/types/map","handling-data/types/number","handling-data/types/object","handling-data/types/set","handling-data/types/string","handling-data/custom-types"]. Implies mismatched parent directories: ["handling-data/types","handling-data/custom-types"].
```
Copy link
Contributor

@bendbennett bendbennett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Superb! This is fantastic 🚀

@bflad bflad added this to the v1.4.0 milestone Aug 16, 2023
Copy link
Member

@austinvalle austinvalle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple comments, but overall this documentation was fantastic, really like the layout! 👍🏻

@bflad bflad modified the milestones: v1.4.0, v1.3.5 Aug 17, 2023
@bflad bflad merged commit 9d46160 into main Aug 17, 2023
1 check passed
@bflad bflad deleted the bflad/docs-data-handling-expansion branch August 17, 2023 16:38
bflad added a commit to hashicorp/terraform-docs-common that referenced this pull request Aug 17, 2023
bflad added a commit to hashicorp/terraform-docs-common that referenced this pull request Aug 17, 2023
@mschuchard
Copy link

mschuchard commented Aug 17, 2023

Past me from six months ago would have very much appreciated this, and therefore so will probably many others in the present and future.

@bflad I also have some proprietary code I developed for doing some crazy stuff with e.g. struct{set(object(object(set(object)))))} conversions among TF specific HCL2 schema, TF types models, TF Go data models, and SDK Go models (to be serialized/marshalled). If that kind of complexity belongs here I could try to sanitize it and contribute it (it would probably need to be reviewed for best practices first which would also be helpful for me anyway). It could also be placed somewhere else I have no idea. Just let me know.

@github-actions
Copy link

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.
If you have found a problem that seems related to this change, 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 Sep 17, 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 this pull request may close these issues.

Make value handling methods more discoverable in the documentation
4 participants