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

[State Management] State syncing utils docs #56479

Merged
merged 11 commits into from
Feb 7, 2020
Merged

[State Management] State syncing utils docs #56479

merged 11 commits into from
Feb 7, 2020

Conversation

Dosant
Copy link
Contributor

@Dosant Dosant commented Jan 31, 2020 •
edited
Loading

Summary

Part of #44151

Since we started using new state syncing utils instead of AppState and GlobalState in management and dashboard 1 2, I hope that the api could be more or less considered stabilised and it is a good time to work on docs.

Still open for discussion are helpers for working with our data plugin (TimeRange, RefreshInterval and Filters) - #55977, #56128. So current pr are docs for basis of state syncing utilities.

For now, for docs, I followed example of state containers docs in kibana_utils.

Please see new rendered md docs for state syncing utilities here.

Dev Docs

Docs for state syncing utils are available at: https://github.com/elastic/kibana/tree/master/src/plugins/kibana_utils/docs/state_sync

Checklist

Use strikethroughs to remove checklist items you don't feel are applicable to this PR.

For maintainers

@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-app-arch (Team:AppArch)

@Dosant Dosant added chore release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. v7.7.0 v8.0.0 review labels Jan 31, 2020
@Dosant Dosant marked this pull request as ready for review January 31, 2020 11:52
@Dosant Dosant requested a review from a team as a code owner January 31, 2020 11:52
@Dosant Dosant mentioned this pull request Jan 31, 2020
Closed
@streamich streamich mentioned this pull request Jan 31, 2020
Closed
30 tasks
lukeelmers
lukeelmers reviewed Jan 31, 2020
View reviewed changes
Copy link
Member

@lukeelmers lukeelmers left a comment

Choose a reason for hiding this comment

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

Did a quick read and so far this looks great!

As for the data helpers; I'm not sure exactly what you had in mind there, but assume that isn't necessarily something that we'd provide from kibana_utils right? (rather, the data plugin would provide anything needed for integration with state provided by its various services).

@Dosant
Copy link
Contributor Author

Dosant commented Jan 31, 2020

@lukeelmers, for that data section, I just wanted to point to helpers we are discussing here and some of them are polished here

@Dosant
Copy link
Contributor Author

Dosant commented Feb 3, 2020

@elasticmachine merge upstream

@Dosant
Copy link
Contributor Author

Dosant commented Feb 4, 2020

@elasticmachine merge upstream

lukeelmers
lukeelmers approved these changes Feb 4, 2020
View reviewed changes
Copy link
Member

@lukeelmers lukeelmers left a comment

Choose a reason for hiding this comment

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

🎊

ppisljar
ppisljar approved these changes Feb 5, 2020
View reviewed changes
Copy link
Member

@ppisljar ppisljar left a comment

Choose a reason for hiding this comment

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

lgtm

@Dosant
Copy link
Contributor Author

Dosant commented Feb 6, 2020

@elasticmachine merge upstream

lizozom
lizozom reviewed Feb 6, 2020
View reviewed changes
Copy link
Contributor

@lizozom lizozom left a comment

Choose a reason for hiding this comment

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

Looks good.
Added some clarifications and grammar fixes

src/plugins/kibana_utils/docs/state_sync/README.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/README.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/empty_or_incomplete_incoming_state.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/empty_or_incomplete_incoming_state.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/empty_or_incomplete_incoming_state.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md Outdated Show resolved Hide resolved
src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md Outdated Show resolved Hide resolved
@Dosant
Copy link
Contributor Author

Dosant commented Feb 6, 2020

@lizozom, Thank you 🙏

@Dosant Dosant merged commit c001014 into elastic:master Feb 7, 2020
Dosant added a commit to Dosant/kibana that referenced this pull request Feb 7, 2020
@Dosant
[State Management][Docs] State syncing utils docs (elastic#56479)
7cb13fb
@Dosant Dosant mentioned this pull request Feb 7, 2020
Merged
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@elastic elastic deleted a comment from kibanamachine Feb 7, 2020
Dosant added a commit that referenced this pull request Feb 7, 2020
@Dosant
[State Management][Docs] State syncing utils docs (#56479) (#57080)
48551a5
@kertal kertal mentioned this pull request Feb 7, 2020
Merged
2 tasks
jloleysens added a commit to jloleysens/kibana that referenced this pull request Feb 7, 2020
@jloleysens
Merge branch 'console/feature/text-objects-in-saved-objects' of githu…
9e266c6 
…b.com:jloleysens/kibana into console/feature/text-objects-in-saved-objects

* 'console/feature/text-objects-in-saved-objects' of github.com:jloleysens/kibana: (103 commits)
  fix auto closing new vis modal when navigating to lens or when navigating away with browser history (elastic#56998)
  TS of esKuery\node_types  (elastic#56857)
  Kibana app migration: Move static code dependencies into kibana_legacy plugin, part 1 (elastic#56408)
  Retry ES API calls that fail with 410/Gone (elastic#56950)
  [APM] Show missing permissions message to the user on the Services overview (elastic#56374)
  Fixing flaky CI tests for custom appRoutes (elastic#55763)
  [State Management][Docs] State syncing utils docs (elastic#56479)
  [Index management] Remove index mapper setting in tests (elastic#57066)
  Exposed common EuiExpressions to separate components be able to reuse for building new for Alert Types  (elastic#56466)
  [SIEM] update url state between page if date is relative (elastic#56813)
  fix for chart_types test (elastic#57056)
  chore(NA): remove compress from dll minimizer (elastic#57023)
  [File upload] Migrate routing to NP & add route validation (elastic#52313)
  Adding docs for grouped nav advanced setting (elastic#57013)
  Use i18n titles for field formatters, human names for numeral locales (elastic#56348)
  [Maps] Remove EMS catalogue url from docs (elastic#57020)
  [Endpoint] ERT-82 ERT-83 ERT-84: Alert list API with pagination (elastic#56538)
  [DOCS] Adds Apple notarization info to install doc (elastic#57042)
  [ML] New Platform server shim: update results service routes to use new platform router (elastic#56886)
  Fix typo on detection engine rule (elastic#56993)
  ...
@kertal kertal mentioned this pull request Feb 10, 2020
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lizozom lizozom lizozom left review comments

@ppisljar ppisljar ppisljar approved these changes

@streamich streamich streamich approved these changes

@lukeelmers lukeelmers lukeelmers approved these changes

Assignees
No one assigned
Labels
chore Feature:StateManagement release_note:plugin_api_changes Contains a Plugin API changes section for the breaking plugin API changes section. review v7.7.0 v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@Dosant @elasticmachine @lukeelmers @lizozom @streamich @ppisljar