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.

Sign up for GitHub

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

Jump to bottom

[PersistableState] Improve documentation for how to use persistable state services #103105

Closed
stacey-gammon opened this issue Jun 23, 2021 · 2 comments · Fixed by #105202
Closed

[PersistableState] Improve documentation for how to use persistable state services #103105

stacey-gammon opened this issue Jun 23, 2021 · 2 comments · Fixed by #105202
Labels
impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort needs_docs

Comments

@stacey-gammon
Copy link
Contributor

stacey-gammon commented Jun 23, 2021 •
edited
Loading

This issue covers two things.

  1. A new tutorial should be added to the developer guide to cover both how to persist persistable state in a saved object (very important to call inject/extract/migration functions), as well as how to implement persistable state (call out how important it is to write a migration function any time you change the shape of your data).
  2. The in-code comments on the persistable state service could be improved or should direct the user to the tutorial for more information.
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-services (Team:AppServices)

@stacey-gammon stacey-gammon mentioned this issue Jun 23, 2021
Closed
3 tasks
@stacey-gammon stacey-gammon changed the title Developer guide tutorial for how to use persistable state services Improve documentation for how to use persistable state services Jun 23, 2021
@exalate-issue-sync exalate-issue-sync bot added impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. loe:small Small Level of Effort impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. and removed impact:low Addressing this issue will have a low level of impact on the quality/strength of our product. labels Jun 24, 2021
@exalate-issue-sync exalate-issue-sync bot changed the title Improve documentation for how to use persistable state services [PersistableState] Improve documentation for how to use persistable state services Jul 12, 2021
@exalate-issue-sync exalate-issue-sync bot added loe:medium Medium Level of Effort and removed loe:small Small Level of Effort labels Jul 12, 2021
@ppisljar ppisljar mentioned this issue Jul 12, 2021
Merged
@stacey-gammon
Copy link
Contributor Author

Peter, can you add a menu navigation entry before closing this so it shows up in the dev guide?

@stacey-gammon stacey-gammon reopened this Sep 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
impact:medium Addressing this issue will have a medium level of impact on the quality/strength of our product. loe:medium Medium Level of Effort needs_docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

persistable state docs ppisljar/kibana
3 participants
@ppisljar @elasticmachine @stacey-gammon