Skip to content

Commit e4c7bbf

Browse files
gchapsKOTungsethkibanamachine
authored
[DOCS] Updates saved objects & other docs (#139328)
* [DOCS] Updates saved objects doc * [DOCS] Edtis tags doc * [DOCS] Removes video from discover docs * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-tags.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-tags.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-tags.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-tags.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-tags.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * Update docs/management/managing-saved-objects.asciidoc Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> * [DOCS] Incorporates review comments Co-authored-by: Kaarina Tungseth <kaarina.tungseth@elastic.co> Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
1 parent 2b0754c commit e4c7bbf

File tree

4 files changed

+93
-83
lines changed

4 files changed

+93
-83
lines changed

docs/discover/document-explorer.asciidoc

Lines changed: 3 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,11 @@
33

44

55
*Discover* displays your documents in table format, so you can
6-
best explore your data.
7-
Use the document table to resize columns, set row height,
6+
best explore your data. Resize columns, set row height,
87
perform multi-column sorting, compare data, and more.
98

10-
++++
11-
<script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js">
12-
</script>
13-
<img
14-
style="width: 100%; margin: auto; display: block;"
15-
class="vidyard-player-embed"
16-
src="https://play.vidyard.com/KbZQP6Y7msjevAm1JGbKeG.jpg"
17-
data-uuid="KbZQP6Y7msjevAm1JGbKeG"
18-
data-v="4"
19-
data-type="inline"
20-
/>
21-
</br>
22-
++++
9+
[role="screenshot"]
10+
image:images/customer.png[Customer last name, first initial in the document table]
2311

2412
[float]
2513
[[document-explorer-columns]]
Lines changed: 73 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,121 +1,139 @@
11
[[managing-saved-objects]]
2-
== Saved Objects
2+
== Manage saved objects
33

4-
The *Saved Objects* UI helps you keep track of and manage your saved objects. These objects
5-
store data for later use, including dashboards, visualizations, maps, data views,
6-
Canvas workpads, and more.
4+
Edit, import, export, and copy your saved objects. These objects include
5+
dashboards, visualizations, maps, {data-sources}, *Canvas* workpads, and other saved objects.
76

8-
To get started, open the main menu, then click *Stack Management > Saved Objects*.
7+
To get started, open the main menu, and then click *Stack Management > Saved Objects*.
98

109
[role="screenshot"]
1110
image::images/management-saved-objects.png[Saved Objects]
1211

1312
[float]
1413
=== Required permissions
1514

16-
The `Saved Objects Management` {kib} privilege is required to access the *Saved Objects* UI.
15+
To access *Saved Objects*, you must have the required `Saved Objects Management` {kib} privilege.
1716

18-
To add the privilege, open the menu, then click *Stack Management > Roles*.
17+
To add the privilege, open the main menu, and then click *Stack Management > Roles*.
1918

20-
NOTE:
21-
Granting access to Saved Objects Management will authorize users to manage all saved objects in {kib}, including objects that are managed by applications they may not otherwise be authorized to access.
19+
NOTE: Granting access to `Saved Objects Management` authorizes users to
20+
manage all saved objects in {kib}, including objects that are managed by
21+
applications they may not otherwise be authorized to access.
2222

2323

2424
[float]
2525
[[managing-saved-objects-view]]
2626
=== View and delete
2727

28-
* To view and edit an object in its associated application, click the object title.
28+
* To view and edit a saved object in its associated application, click the object title.
2929

3030
* To show objects that use this object, so you know the
3131
impact of deleting it, click the actions icon image:images/actions_icon.png[Actions icon]
32-
and select *Relationships*.
32+
and then select *Relationships*.
3333

3434
* To delete one or more objects, select their checkboxes, and then click *Delete*.
3535

3636
[float]
3737
[[managing-saved-objects-export-objects]]
3838
=== Import and export
3939

40-
Using the import and export actions, you can move objects between different
41-
{kib} instances. This action is useful when you
42-
have multiple environments for development and production.
43-
Import and export also work well when you have a large number
44-
of objects to update and want to batch the process.
40+
Use import and export to move objects between different {kib} instances.
41+
These actions are useful when you have multiple environments for development and production.
42+
Import and export also work well when you have a large number of objects to update and want to batch the process.
4543

46-
In addition to the user interface, {kib} provides beta <<saved-objects-api-import, import>> and <<saved-objects-api-export, export>> APIs if
47-
you want to automate this process.
44+
{kib} also provides <<saved-objects-api-import, import>> and
45+
<<saved-objects-api-export, export>> APIs to automate this process.
4846

49-
[float]
50-
==== Compatibility across versions
51-
52-
With each release, {kib} introduces changes to the way saved objects are stored. When importing a saved object, {kib} will run the necessary migrations to ensure that the imported saved objects are compatible with the current version.
53-
54-
However, saved objects can only be imported into the same version, a newer minor on the same major, or the next major. Exported saved objects are not backwards compatible and cannot be imported into an older version of {kib}. See the table below for compatibility examples:
55-
56-
|=======
57-
| Exporting version | Importing version | Compatible?
58-
| 6.7.0 | 6.8.1 | Yes
59-
| 6.8.1 | 7.3.0 | Yes
60-
| 7.3.0 | 7.11.1 | Yes
61-
| 7.11.1 | 7.6.0 | No
62-
| 6.8.1 | 8.0.0 | No
63-
|=======
6447

6548
[float]
6649
==== Import
6750

68-
You can import multiple objects in a single operation. Click *Import* and
69-
navigate to the NDJSON file that
70-
represents the objects to import. By default,
51+
Import multiple objects in a single operation.
52+
53+
. In the toolbar, click *Import*.
54+
. Select the NDJSON file that
55+
includes the objects you want to import.
56+
. Select the import options. By default,
7157
saved objects already in {kib} are overwritten.
58+
. Click *Import*.
7259

7360
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
74-
limits the number of saved objects which may be included in this file. Similarly, the
61+
limits the number of saved objects to include in the file. The
7562
<<savedObjects-maxImportPayloadBytes, `savedObjects.maxImportPayloadBytes`>> setting limits the overall
76-
size of the file that can be imported.
63+
size of the file that you can import.
7764

7865

7966
[float]
8067
==== Export
8168

82-
You have two options for exporting saved objects.
69+
Export objects by selection or type.
8370

84-
* Select the checkboxes of objects that you want to export, and then click *Export*.
85-
* Click *Export x objects*, and export objects by type.
71+
* To export specific objects, select them in the table, and then click *Export*.
72+
* To export objects by type, click *Export objects* in the toolbar.
8673

87-
This action creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects that are related to the saved
88-
objects. Exported dashboards include their associated data views.
74+
{kib} creates an NDJSON with all your saved objects. By default, the NDJSON includes child objects related to the saved
75+
objects. Exported dashboards include their associated {data-sources}.
8976

9077
NOTE: The <<savedObjects-maxImportExportSize, `savedObjects.maxImportExportSize`>> configuration setting
91-
limits the number of saved objects which may be exported.
78+
limits the number of saved objects that you can export.
79+
80+
[float]
81+
==== Compatibility across versions
82+
83+
With each release, {kib} introduces changes to the way saved objects are stored.
84+
When importing a saved object, {kib} runs the necessary migrations to ensure
85+
that the imported saved objects are compatible with the current version.
86+
87+
However, saved objects can only be imported into the same version,
88+
a newer minor on the same major, or the next major.
89+
Exported saved objects are not backward compatible and cannot be imported
90+
into an older version of {kib}. For example:
91+
92+
|=======
93+
| Exporting version | Importing version | Compatible?
94+
| 6.7.0 | 6.8.1 | Yes
95+
| 6.8.1 | 7.3.0 | Yes
96+
| 7.3.0 | 7.11.1 | Yes
97+
| 7.11.1 | 7.6.0 | No
98+
| 6.8.1 | 8.0.0 | No
99+
|=======
100+
92101

93102

94103
[float]
95104
[role="xpack"]
96105
[[managing-saved-objects-copy-to-space]]
97106
=== Copy to other {kib} spaces
98107

99-
To copy a saved object to another space, click the actions icon image:images/actions_icon.png[Actions icon]
100-
and select *Copy to spaces*. From here, you can select the spaces in which to copy the object.
101-
You can also select whether to automatically overwrite any conflicts in the target spaces, or
102-
resolve them manually.
108+
Copy saved objects and their related objects between spaces.
103109

104-
WARNING: The copy operation automatically includes child objects that are related to the saved objects. If you don't want this behavior, use
110+
. Click the actions icon image:images/actions_icon.png[Actions icon].
111+
. Click *Copy to spaces*.
112+
. Select the spaces in which to copy the object.
113+
. Specify whether to automatically overwrite any objects that already exist
114+
in the target spaces, or resolve them on a per-object basis.
115+
+
116+
The copy operation automatically includes child objects that are related to
117+
the saved object. If you don't want this behavior, use
105118
the <<spaces-api-copy-saved-objects, copy saved objects to space API>> instead.
106119

107120
[float]
108121
[role="xpack"]
109122
[[managing-saved-objects-share-to-space]]
110123
=== Share to other {kib} spaces
111124

112-
To share a saved object to another space -- which makes a single saved object available in multiple spaces -- click the actions icon
113-
image:images/actions_icon.png[Actions icon] and select *Share to spaces*. From here, you can select the spaces in which to share the object,
114-
or indicate that you want the object to be shared to _all spaces_, which includes those that exist now and any created in the future.
125+
Make a single saved object available in multiple spaces.
115126

116-
Not all saved object types are shareable. If an object is shareable, the Spaces column shows which spaces it exists in. You can also click
127+
. Click the actions icon
128+
image:images/actions_icon.png[Actions icon].
129+
. Select *Share to spaces*.
130+
. Select the spaces in which to share the object.
131+
Or, indicate that you want the object to be shared to _all spaces_,
132+
which includes those that exist now and any created in the future.
133+
+
134+
Not all saved object types are shareable. If an object is shareable, the *Spaces* column shows where the object exists. You can click
117135
those space icons to open the Share UI.
118-
119-
WARNING: The share operation automatically includes child objects that are related to the saved objects.
136+
+
137+
The share operation automatically includes child objects that are related to the saved objects.
120138

121139
include::saved-objects/saved-object-ids.asciidoc[]

docs/management/managing-tags.asciidoc

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
[[managing-tags]]
33
== Tags
44

5-
Tags enable you to categorize your saved objects.
6-
You can then filter for related objects based on shared tags.
5+
Use tags to categorize your saved objects,
6+
then filter for related objects based on shared tags.
7+
8+
To get started, open the main menu, and then click *Stack Management > Tags*.
79

810
[role="screenshot"]
911
image::images/tags/tag-management-section.png[Tags management]
@@ -29,7 +31,6 @@ from the global search.
2931

3032
Create a tag to assign to your saved objects.
3133

32-
. Open the main menu, and then click *Stack Management > Tags*.
3334
. Click *Create tag*.
3435

3536
. Enter a name and select a color for the new tag.
@@ -41,30 +42,33 @@ The name cannot be longer than 50 characters.
4142
[[settings-assign-tag]]
4243
=== Assign a tag to an object
4344

44-
To assign and remove tags from saved objects, you must have `write` permission
45+
To assign and remove tags, you must have `write` permission
4546
on the objects to which you assign the tags.
4647

47-
. In the *Tags* view, find the tag you want to assign.
48-
. Click the action menu (...) in the tag row,
49-
and then select the *Manage assignments* action.
48+
. Find the tag you want to assign.
49+
. Click the actions icon
50+
image:images/actions_icon.png[Actions icon],
51+
and then select *Manage assignments*.
5052

5153
. Select the objects to which you want to assign or remove tags.
5254
+
5355
[role="screenshot"]
54-
image::images/tags/manage-assignments-flyout.png[Assign flyout]
56+
image::images/tags/manage-assignments-flyout.png[Assign flyout, width=75%]
5557

5658
. Click *Save tag assignments*.
5759

58-
TIP: To assign, delete, or clear multiple tags at once,
59-
select their checkboxes in the *Tags* view, and then select
60-
the desired action from the *selected tags* menu.
6160

6261
[float]
6362
[[settings-delete-tag]]
6463
=== Delete a tag
6564

6665
When you delete a tag, you remove it from all saved objects that use it.
6766

68-
. Click the action menu (...) in the tag row, and then select the *Delete* action.
67+
. Click the actions icon
68+
image:images/actions_icon.png[Actions icon], and then select *Delete*.
6969

7070
. Click *Delete tag*.
71+
72+
TIP: To assign, delete, or clear multiple tags,
73+
select them in the *Tags* view, and then select
74+
the action from the *selected tags* menu.

docs/user/graph/getting-started.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ a field, select *Edit Settings*, and change *Terms per hop*.
9595
Documents that match a blocked term are not allowed in the graph.
9696
To block a term, select its vertex and click
9797
the block icon
98-
image:user/graph/images/graph-block-button.png[Block selection]
98+
image:user/graph/images/graph-block-button.png[Block list]
9999
in the control panel.
100100
For a list of blocked terms, go to *Settings > Blocked terms*.
101101

0 commit comments

Comments
 (0)