Add saved object docs by stacey-gammon · Pull Request #90860 · elastic/kibana

stacey-gammon · 2021-02-09T21:55:48Z

Add a key concepts section with high level info:

Tutorial section with content taken from https://www.elastic.co/guide/en/kibana/current/kibana-platform-api.html#saved-objects-service

kobelb

These docs are great!

dev_docs/key_concepts/saved_objects.mdx

kobelb · 2021-02-09T23:46:30Z

dev_docs/key_concepts/saved_objects.mdx

+
+## References
+
+In order to support import and export capabilities, Saved Objects need to explicitly list any references they contain to other Saved Objects.


References also come into play for multi-space saved-objects. When sharing a saved-object to another space, all direct and transitive children must be shared as well, to prevent having a broken object graph.

dev_docs/key_concepts/saved_objects.mdx

dev_docs/tutorials/saved_objects.mdx

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

kobelb

These are great, I wish we had these years ago.

kibanamachine · 2021-02-11T15:44:18Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💚 Build #105771 succeeded 52c57fd
💚 Build #105635 succeeded 6e150be
💚 Build #105633 succeeded 50d0b48
💚 Build #105636 succeeded ad63ae9
💚 Build #105613 succeeded bb72886

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

* iwp * add docs on saved objects * add saved object docs * Update dev_docs/key_concepts/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * review updates * remove this line, support being added Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

kibanamachine · 2021-02-11T16:30:41Z

Backport result

{"level":"info","message":"POST https://api.github.com/graphql (status: 200)"}
{"level":"info","message":"POST https://api.github.com/graphql (status: 200)"}
{"meta":{"labels":["Project:DevDocs","auto-backport","backport","docs","release_note:skip","v7.12.0","v8.0.0"],"branchLabelMapping":{"^v8.0.0$":"master","^v7.12.0$":"7.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"},"existingTargetPullRequests":[]},"level":"info","message":"Inputs when calculating target branches:"}
{"meta":["7.x"],"level":"info","message":"Target branches inferred from labels:"}
{"meta":{"killed":false,"code":2,"signal":null,"cmd":"git remote rm kibanamachine","stdout":"","stderr":"error: No such remote: 'kibanamachine'\n"},"level":"info","message":"exec error 'git remote rm kibanamachine':"}
{"meta":{"killed":false,"code":2,"signal":null,"cmd":"git remote rm elastic","stdout":"","stderr":"error: No such remote: 'elastic'\n"},"level":"info","message":"exec error 'git remote rm elastic':"}
{"level":"info","message":"Backporting [{\"sourceBranch\":\"master\",\"targetBranchesFromLabels\":[\"7.x\"],\"sha\":\"9fca7a9012f8d6944d40db1aee00e6adabef2c3c\",\"formattedMessage\":\"Add saved object docs (#90860)\",\"originalMessage\":\"Add saved object docs (#90860)\\n\\n* iwp\\r\\n\\r\\n* add docs on saved objects\\r\\n\\r\\n* add saved object docs\\r\\n\\r\\n* Update dev_docs/key_concepts/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* Update dev_docs/tutorials/saved_objects.mdx\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\\r\\n\\r\\n* review updates\\r\\n\\r\\n* remove this line, support being added\\r\\n\\r\\nCo-authored-by: Brandon Kobel <brandon.kobel@gmail.com>\",\"pullNumber\":90860,\"existingTargetPullRequests\":[]}] to 7.x"}

Backporting to 7.x:
{"level":"info","message":"Backporting via filesystem"}
{"level":"info","message":"Creating PR with title: \"[7.x] Add saved object docs (#90860)\". kibanamachine:backport/7.x/pr-90860 -> 7.x"}
{"level":"info","message":"POST /repos/elastic/kibana/pulls - 201 in 1155ms"}
{"level":"info","message":"Adding assignees to #91152: stacey-gammon"}
{"level":"info","message":"POST /repos/elastic/kibana/issues/91152/assignees - 201 in 552ms"}
{"level":"info","message":"Adding labels: backport"}
{"level":"info","message":"POST /repos/elastic/kibana/issues/91152/labels - 200 in 364ms"}
View pull request: https://github.com/elastic/kibana/pull/91152

* iwp * add docs on saved objects * add saved object docs * Update dev_docs/key_concepts/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * Update dev_docs/tutorials/saved_objects.mdx Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> * review updates * remove this line, support being added Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com> Co-authored-by: Stacey Gammon <gammon@elastic.co> Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Stacey Gammon added 3 commits February 9, 2021 16:36

iwp

6da1b9e

add docs on saved objects

0a356b6

add saved object docs

e2f116d

stacey-gammon added docs DevDocs labels Feb 9, 2021

stacey-gammon requested review from joshdover and kobelb February 9, 2021 21:56

stacey-gammon added release_note:skip Skip the PR/issue when compiling release notes v7.12.0 v8.0.0 labels Feb 9, 2021

kobelb reviewed Feb 10, 2021

View reviewed changes

Stacey Gammon and others added 8 commits February 10, 2021 10:20

Update dev_docs/key_concepts/saved_objects.mdx

bb72886

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

f1408c7

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

5973e67

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

50d0b48

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

3103ff2

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

6e150be

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

Update dev_docs/tutorials/saved_objects.mdx

ad63ae9

Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>

review updates

52c57fd

kobelb approved these changes Feb 10, 2021

View reviewed changes

remove this line, support being added

15a7748

stacey-gammon added auto-backport Deprecated - use backport:version if exact versions are needed backport This PR is a backport of another PR labels Feb 11, 2021

stacey-gammon merged commit 9fca7a9 into elastic:master Feb 11, 2021

kibanamachine mentioned this pull request Feb 11, 2021

[7.x] Add saved object docs (#90860) #91152

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add saved object docs#90860

Add saved object docs#90860
stacey-gammon merged 12 commits intoelastic:masterfrom
stacey-gammon:2021-02-04-saved-object-docs

stacey-gammon commented Feb 9, 2021

Uh oh!

kobelb left a comment

Uh oh!

Uh oh!

Uh oh!

kobelb Feb 9, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kobelb left a comment

Uh oh!

kibanamachine commented Feb 11, 2021

Uh oh!

kibanamachine commented Feb 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		## References

		In order to support import and export capabilities, Saved Objects need to explicitly list any references they contain to other Saved Objects.

Conversation

stacey-gammon commented Feb 9, 2021

Uh oh!

kobelb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kobelb Feb 9, 2021

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kobelb left a comment

Choose a reason for hiding this comment

Uh oh!

kibanamachine commented Feb 11, 2021

💚 Build Succeeded

Metrics [docs]

History

Uh oh!

kibanamachine commented Feb 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants