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

Adding website documentation for private state management #458

Merged
merged 5 commits into from Aug 30, 2022

Conversation

bendbennett
Copy link
Contributor

Closes: #449

@bendbennett bendbennett added the documentation Improvements or additions to documentation label Aug 23, 2022
@bendbennett bendbennett requested a review from a team as a code owner August 23, 2022 12:54
@bflad bflad self-assigned this Aug 29, 2022
@bflad bflad added this to the v0.12.0 milestone Aug 29, 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.

Overall looks good to me, just a few minor touch ups. 🚀

website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
website/docs/plugin/framework/resources/private-state.mdx Outdated Show resolved Hide resolved
}
```

If the key supplied is reserved for framework usage, an error diagnostic will be returned.
Copy link
Member

Choose a reason for hiding this comment

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

We should discuss the reserved keys somewhere 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bflad I've added a few words into a Reserved Keys section.

@bendbennett bendbennett merged commit 47f5b81 into main Aug 30, 2022
@bendbennett bendbennett deleted the bendbennett/issues-449 branch August 30, 2022 15:34
@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 30, 2022
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.

Add Website Documentation for Private State Management via privatestate pkg
2 participants