-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
[DOCS] Updates Saved objects docs #45310
Conversation
Pinging @elastic/kibana-docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few nits and comments but great to see this section getting updated 👍
and import commands allow you to move objects between different {kib} instances. | ||
* You have a large number of objects to update and want to batch this process. | ||
Import and export also work well when you have a large number | ||
of objects to update and want to batch the process. | ||
You can export the objects to JSON, make the JSON modification, and re-import |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this part didn't get touched by you but wanted to note it's no longer true. The new export gives NDJSON files that are hard to make modifications to and wouldn't be recommended to be modified. On the other hand, migrations will run on the objects if ever the structure needs to change.
==== Import | ||
|
||
You can import multiple objects in a single operation. Click *Import* and | ||
navigate to the JSON file that |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here would be an NDJSON file.
* Select the checkboxes of objects that you want to export, and then click *Export*. | ||
* Click *Export x objects*, and select which object types to export. | ||
|
||
This action exports a JSON with all your saved objects. By default, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here (NDJSON file).
* Click *Export x objects*, and select which object types to export. | ||
|
||
This action exports a JSON with all your saved objects. By default, | ||
the export includes related objects. | ||
|
||
WARNING: Exported dashboards do not include their associated index patterns. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This warning can be removed. If the "include related objects" is selected, the dashboard will export everything down to the index pattern now.
|
||
* Recreate the index so you can continue using the object. | ||
* Delete the object and recreate it using a different index. | ||
* Change the index name referenced in the object's `kibanaSavedObjectMeta.searchSourceJSON` to point to an existing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if the id
of the index pattern would still be in kibanaSavedObjectMeta.searchSourceJSON
. I believe as of 7.0, it's now within references
array (Shown under a separate textbox within the inspect screen).
@@ -1,81 +1,82 @@ | |||
[[managing-saved-objects]] | |||
== Managing Saved Objects | |||
== Saved objects |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: we could rename the file and related image file to remove management
in its name.
|
||
To delete a saved object, select its checkbox and click *Delete*. | ||
* To delete one or more objects, select their checkboxes and click *Delete*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since you complete one action after the other, shouldn't this be:
...select their checkboxes, then click *Delete*.
|
||
To narrow the list of saved objects, enter a search term or select an object | ||
type. | ||
Saved objects store your visualizations, dashboards, maps, Canvas workpads, and more. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aren't saved objects
and visualizations, dashboards, maps, Canvas workpads, and more
the same thing?
How about:
Save your Kibana objects to use at a later time. Objects include visualizations, dashboards, maps, Canvas workpads, and more.
* Select the checkboxes of objects that you want to export, and then click *Export*. | ||
* Click *Export x objects*, and select which object types to export. | ||
|
||
This action exports a NDJSON with all your saved objects. By default, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
exports
should be creates
* Click *Export x objects*, and select which object types to export. | ||
|
||
This action exports a NDJSON with all your saved objects. By default, | ||
the export includes related objects. Exported dashboards include their associated index patterns. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
export
should be NDJSON
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Looks good to me 👍
* [DOCS] Updates Saved objects docs * [DOCS] Incorporates review comments * [DOCS] Changed intro per review comments * [DOCS] More updates to Saved objects doc
* [DOCS] Updates Saved objects docs * [DOCS] Incorporates review comments * [DOCS] Changed intro per review comments * [DOCS] More updates to Saved objects doc
Summary
This PR updates the Saved objects doc.
[skip ci]