Add user doc for SO tagging (#85557)

* Add user doc for SO tagging

* add link to new page

* handle review feedbacks

* second pass
This commit is contained in:
Pierre Gayvallet 2020-12-17 08:50:31 +01:00 committed by GitHub
parent 25548bbae4
commit b201843e68
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 80 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 209 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 338 KiB

View file

@ -0,0 +1,75 @@
[role="xpack"]
[[managing-tags]]
== Tags
Tags enable you to categorize your saved objects. You can then easily filter for related objects based on shared tags.
To begin, open the main menu, click *Stack Management*, then click *Tags*.
[role="screenshot"]
image::images/tags/tag-management-section.png[Tags management section]
[float]
=== Required permissions
Access to *Tags* requires the `Tag Management` {kib} privilege. To add the privilege, open the menu,
click *Stack Management*, then click *Roles*.
In addition:
* The `read` privilege allows you to assign tags to the saved objects for which you have write permission.
* The `write` privilege enables you to create, edit, and delete tags.
NOTE: Having the `Tag Management` {kib} privilege is not required to
view tags assigned on objects the user has `read` access to, or to filter objects by tags
in {kib} applications or from the navigational search.
[float]
[[settings-create-tag]]
=== Create a tag
Create a tag to assign to your saved objects.
. Click *Create tag*.
+
[role="screenshot"]
image::images/tags/create-tag.png[Tag creation popin]
. Enter a name and select a color for the new tag.
+
The name can include alphanumeric characters (English letters and digits), `:`, `-`, `_` and the space character,
and cannot be longer than 50 characters.
. Click *Create tag*.
[float]
[[settings-assign-tag]]
=== Assign a tag to saved objects
Assign or remove tags to one or more saved objects. You must have `write` permission
on the objects to which you assign the tags.
. Click the action (...) icon in the tag row, and then select the *Manage assignments* action.
+
[role="screenshot"]
image::images/tags/manage-assignments-flyout.png[Assign flyout]
. Select the objects to which you want to assign or remove tags.
. Click on *Save tag assignments*.
TIP: To assign multiple tags to objects at once, select their checkboxes
and then select *Manage tag assignments* from the *selected tags* menu.
[role="screenshot"]
image::images/tags/bulk-assign-selection.png[Bulk assign tags]
[float]
[[settings-delete-tag]]
=== Delete a tag
Delete a tag and remove it from any saved objects.
. Click the action (...) icon in the tag row, and then select the *Delete* action.
. Click *Delete tag*.
TIP: To delete multiple tags at once, select their checkboxes in the list view,
and then select *Delete* action from the *selected tags* menu.

View file

@ -139,6 +139,9 @@ a| <<index-patterns, Index Patterns>>
| Copy, edit, delete, import, and export your saved objects.
These include dashboards, visualizations, maps, index patterns, Canvas workpads, and more.
| <<managing-tags, Tags>>
|Create, manage, and assign tags to your saved objects.
| <<xpack-spaces, Spaces>>
| Create spaces to organize your dashboards and other saved objects into categories.
A space is isolated from all other spaces,
@ -196,6 +199,8 @@ include::{kib-repo-dir}/management/rollups/create_and_manage_rollups.asciidoc[]
include::{kib-repo-dir}/management/managing-saved-objects.asciidoc[]
include::{kib-repo-dir}/management/managing-tags.asciidoc[]
include::security/index.asciidoc[]
include::{kib-repo-dir}/management/snapshot-restore/index.asciidoc[]