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

Improvements to Documentation #584

Merged
merged 2 commits into from Dec 15, 2022
Merged

Improvements to Documentation #584

merged 2 commits into from Dec 15, 2022

Conversation

bendbennett
Copy link
Contributor

Closes: #583

@bendbennett bendbennett added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 14, 2022
@bendbennett bendbennett requested a review from a team as a code owner December 14, 2022 15:34
@bflad bflad self-assigned this Dec 14, 2022
@bflad bflad added this to the v1.0.1 milestone Dec 14, 2022
Copy link
Member

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Nice!

Custom Types.
---

# Custom Types
Copy link
Member

Choose a reason for hiding this comment

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

The Attributes page has a "Create Provider-Defined Types and Values" section that should likely have its content moved here and then linked 👍


## Terraform Configuration and Schema

### Simple Attributes
Copy link
Member

Choose a reason for hiding this comment

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

The "Framework Types and Value Types" above walks through many of these Simple/Collection configuration and schema examples although it looks like they need to be updated for schema.XXXAttribute syntax (which I'll handle separately).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok. I'll remove these, I just thought there might be some value in being able to quickly scan the TF configuration and the schema to see the correlation for simple attributes between the two.

}
```

### Nested Attributes
Copy link
Member

Choose a reason for hiding this comment

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

I think these are omitted from the above sections, so it'll be good to walk through these. Do you think you could structure this new content to look more similar to the existing content (e.g. split per attribute type). Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Ah ha, it was awkwardly on the Schemas page -- I think that content can be moved here. 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Have moved the content and consolidated the TF configuration and schema examples for nested attributes.

Copy link
Member

@bflad bflad left a comment

Choose a reason for hiding this comment

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

Looks great to me 🚀

@bendbennett bendbennett merged commit 221ae8f into main Dec 15, 2022
@bendbennett bendbennett deleted the bendbennett/issues-583 branch December 15, 2022 13:42
@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 Jan 15, 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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Framework Documentation
2 participants