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

First stab at developer-focussed saved objects docs #71430

Merged
merged 12 commits into from
Sep 28, 2020
Merged

First stab at developer-focussed saved objects docs #71430

merged 12 commits into from
Sep 28, 2020

Conversation

rudolf
Copy link
Contributor

@rudolf rudolf commented Jul 13, 2020 •
edited
Loading

Summary

There's a lot developers need to consider when using Saved Objects from their Kibana Plugin. This adds the first bit of developer-focussed documentation:

  • why are saved objects useful for plugin authors
  • casing convention for saved object type names
  • minimal guidelines for saved object mappings, don't index every field
  • how to use Saved Object references
  • how to write migrations

Written as asciidoc in preparation for #41833

Checklist

Delete any items that are not applicable to this PR.

For maintainers

@rudolf rudolf added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Saved Objects labels Jul 13, 2020
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-platform (Team:Platform)

@rudolf
Copy link
Contributor Author

rudolf commented Jul 13, 2020

@timroes @streamich Hope this begins to document some of the discussions we recently had. I tried to get something minimal out quickly, but let me know if you think there's an important missing piece of information that needs to be included.

@rudolf rudolf added release_note:skip Skip the PR/issue when compiling release notes v8.0.0 labels Jul 13, 2020
@rudolf rudolf requested a review from timroes July 15, 2020 13:53
pgayvallet
pgayvallet reviewed Sep 14, 2020
View reviewed changes
docs/developer/architecture/development-plugin-saved-objects.asciidoc Show resolved Hide resolved
docs/developer/architecture/development-plugin-saved-objects.asciidoc Outdated
`dashboard.panels[0].visualization` there is a risk that this `id` gets
updated without updating the reference in the references array.

// TODO: Writing migrations
Copy link
Contributor

Choose a reason for hiding this comment

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

I was going to ask about that one 😄

Copy link
Contributor

Choose a reason for hiding this comment

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

I did start some docs here: rudolf#1

We could merge that and remove the part about nested SO migrations for now.

docs/developer/architecture/development-plugin-saved-objects.asciidoc Outdated Show resolved Hide resolved
@peterschretlen peterschretlen mentioned this pull request Sep 18, 2020
Closed
@rudolf rudolf mentioned this pull request Sep 23, 2020
Merged
pgayvallet
pgayvallet approved these changes Sep 24, 2020
View reviewed changes
Copy link
Contributor

@pgayvallet pgayvallet left a comment

Choose a reason for hiding this comment

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

LGTM

docs/developer/architecture/development-plugin-saved-objects.asciidoc Outdated Show resolved Hide resolved
@rudolf rudolf merged commit 8841757 into elastic:master Sep 28, 2020
@rudolf rudolf deleted the saved-objects-dev-docs branch September 28, 2020 13:53
gmmorris added a commit to gmmorris/kibana that referenced this pull request Sep 28, 2020
@gmmorris
Merge branch 'master' into task-manager/health
6b81d56 
* master:
  Fix APM lodash imports (elastic#78438)
  Add deprecated message to tile_map and region_map visualizations. (elastic#77683)
  Fix Lens smokescreen flaky tests (elastic#78566)
  updated discover with alt text (elastic#77660)
  Fix types (elastic#78619)
  Update tutorial-visualizing.asciidoc (elastic#76977)
  Update tutorial-discovering.asciidoc (elastic#76976)
  [Search] Error notification alignment (elastic#77788)
  Update tutorial-define-index.asciidoc (elastic#76975)
  [Lens] Fieldless operations (elastic#78080)
  [Usage Collection] [schema] Explicit "array" definition (elastic#78141)
  Update tutorial-define-index.asciidoc (elastic#76973)
  Fix --no-basepath references in doc (elastic#78570)
  Move StubIndexPattern to data plugin and convert to TS. (elastic#78518)
  Index pattern class - remove unused methods (elastic#78538)
  [Security Solution] [ALL] Eliminates all console.error and console.warn from Jest output (elastic#78523)
  [Actions] avoids setting a default dedupKey on PagerDuty (elastic#77773)
  First stab at developer-focussed saved objects docs (elastic#71430)
  remove unnecessary config validations (elastic#78527)
@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Sep 30, 2020
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

7 similar comments
@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@kibanamachine
Copy link
Contributor

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create backports run node scripts/backport --pr 71430 or prevent reminders by adding the backport:skip label.

@rudolf rudolf added backport:skip This commit does not require backporting and removed backport missing Added to PRs automatically when the are determined to be missing a backport. labels Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pgayvallet pgayvallet pgayvallet approved these changes

@timroes timroes Awaiting requested review from timroes

@joshdover joshdover Awaiting requested review from joshdover

Assignees
No one assigned
Labels
backport:skip This commit does not require backporting Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rudolf @elasticmachine @kibanamachine @pgayvallet @joshdover