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.

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

Merged
merged 4 commits into from
Sep 11, 2019

Conversation

gchaps
Copy link
Contributor

@gchaps gchaps commented Sep 10, 2019

Summary

This PR updates the Saved objects doc.

[skip ci]

@gchaps gchaps added Team:Docs v8.0.0 release_note:skip Skip the PR/issue when compiling release notes v7.4.0 v7.5.0 labels Sep 10, 2019
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs

Copy link
Contributor

@mikecote mikecote left a 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
Copy link
Contributor

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
Copy link
Contributor

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,
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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*.
Copy link
Contributor

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.
Copy link
Contributor

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,
Copy link
Contributor

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.
Copy link
Contributor

Choose a reason for hiding this comment

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

export should be NDJSON

Copy link
Contributor

@mikecote mikecote left a 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 👍

@gchaps gchaps merged commit c5e7a98 into elastic:master Sep 11, 2019
@gchaps gchaps deleted the docs/update-saved-objects branch September 11, 2019 21:45
gchaps added a commit to gchaps/kibana that referenced this pull request Sep 11, 2019
* [DOCS] Updates Saved objects docs

* [DOCS] Incorporates review comments

* [DOCS] Changed intro per review comments

* [DOCS] More updates to Saved objects doc
gchaps added a commit to gchaps/kibana that referenced this pull request Sep 11, 2019
* [DOCS] Updates Saved objects docs

* [DOCS] Incorporates review comments

* [DOCS] Changed intro per review comments

* [DOCS] More updates to Saved objects doc
gchaps added a commit that referenced this pull request Sep 12, 2019
* [DOCS] Updates Saved objects docs

* [DOCS] Incorporates review comments

* [DOCS] Changed intro per review comments

* [DOCS] More updates to Saved objects doc
gchaps added a commit that referenced this pull request Sep 12, 2019
* [DOCS] Updates Saved objects docs

* [DOCS] Incorporates review comments

* [DOCS] Changed intro per review comments

* [DOCS] More updates to Saved objects doc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release_note:skip Skip the PR/issue when compiling release notes Team:Docs v7.4.0 v7.5.0 v8.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants