[State Management] State syncing utils docs by Dosant · Pull Request #56479 · elastic/kibana

Dosant · 2020-01-31T10:37:32Z

Summary

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.

This was checked for cross-browser compatibility, including a check against IE11
Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility

For maintainers

This was checked for breaking API changes and was labeled appropriately
This includes a feature addition or change that requires a release note and was labeled appropriately

elasticmachine · 2020-01-31T11:49:25Z

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

lukeelmers

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 · 2020-01-31T21:22:28Z

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

Dosant · 2020-02-03T10:57:56Z

@elasticmachine merge upstream

src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md

…to docs/state-management-1

Dosant · 2020-02-04T09:58:39Z

@elasticmachine merge upstream

lukeelmers

🎊

ppisljar

lgtm

Dosant · 2020-02-06T12:02:32Z

@elasticmachine merge upstream

lizozom

Looks good.
Added some clarifications and grammar fixes

src/plugins/kibana_utils/docs/state_sync/README.md

src/plugins/kibana_utils/docs/state_sync/empty_or_incomplete_incoming_state.md

src/plugins/kibana_utils/docs/state_sync/on_fly_state_migrations.md

Dosant · 2020-02-06T14:40:06Z

@lizozom, Thank you 🙏

elasticmachine · 2020-02-07T09:03:38Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request
Commit: 94a9159

History

💚 Build #24923 succeeded 94a9159
💚 Build #24881 succeeded 039781e
💚 Build #24257 succeeded af3e161

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

…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) ...

Dosant added 4 commits January 30, 2020 12:47

wip

8e94487

docs wip

33b40d4

typos

3fd5a1f

improve

87024a1

Dosant added the Team:AppArch label Jan 31, 2020

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 marked this pull request as ready for review January 31, 2020 11:52

Dosant requested a review from a team as a code owner January 31, 2020 11:52

Dosant requested review from lizozom, lukeelmers, ppisljar and streamich January 31, 2020 11:52

Dosant mentioned this pull request Jan 31, 2020

[DISCUSS] State management plugin API #55977

Closed

streamich mentioned this pull request Jan 31, 2020

State Management 👉 New Platform #44151

Closed

30 tasks

Dosant added the Feature:StateManagement label Jan 31, 2020

lukeelmers reviewed Jan 31, 2020

View reviewed changes

Merge branch 'master' into docs/state-management-1

b7863d9

streamich approved these changes Feb 3, 2020

View reviewed changes

src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md Outdated Show resolved Hide resolved

src/plugins/kibana_utils/docs/state_sync/storages/session_storage.md Outdated Show resolved Hide resolved

Dosant added 2 commits February 3, 2020 13:26

review comments

03b35ef

Merge branch 'docs/state-management-1' of github.com:Dosant/kibana in…

6b2e9c9

…to docs/state-management-1

Merge branch 'master' into docs/state-management-1

af3e161

lukeelmers approved these changes Feb 4, 2020

View reviewed changes

ppisljar approved these changes Feb 5, 2020

View reviewed changes

Merge branch 'master' into docs/state-management-1

039781e

lizozom reviewed Feb 6, 2020

View reviewed changes

@lizozom review

f89c652

@lizozom review 2

94a9159

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

[State Management][Docs] State syncing utils docs (elastic#56479)

7cb13fb

Dosant mentioned this pull request Feb 7, 2020

[7.x] [State Management][Docs] State syncing utils docs (#56479) #57080

Merged

elastic deleted a comment from kibanamachine Feb 7, 2020

Dosant added a commit that referenced this pull request Feb 7, 2020

[State Management][Docs] State syncing utils docs (#56479) (#57080)

48551a5

kertal mentioned this pull request Feb 7, 2020

[Discover] Migrate context AppState / GlobalState to use new app state helpers #57078

Merged

2 tasks

kertal mentioned this pull request Feb 10, 2020

[Discover] Migrate AppState/GlobalState to new app state helpers #57175

Merged

2 tasks

Conversation

Dosant commented Jan 31, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Dev Docs

Checklist

For maintainers

Uh oh!

elasticmachine commented Jan 31, 2020

Uh oh!

lukeelmers left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant commented Jan 31, 2020

Uh oh!

Dosant commented Feb 3, 2020

Uh oh!

Uh oh!

Uh oh!

Dosant commented Feb 4, 2020

Uh oh!

lukeelmers left a comment

Choose a reason for hiding this comment

Uh oh!

ppisljar left a comment

Choose a reason for hiding this comment

Uh oh!

Dosant commented Feb 6, 2020

Uh oh!

lizozom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Dosant commented Feb 6, 2020

Uh oh!

elasticmachine commented Feb 7, 2020

💚 Build Succeeded

History

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Comments

Dosant commented Jan 31, 2020 •

edited

Loading