Skip to content

Commit

Permalink
[Docs] Docs for dashboard creator and editor (elastic#189301)
Browse files Browse the repository at this point in the history
## Summary

This PR adds documentation relative to the dashboard creator and last
editor information added to Kibana 8.15.
The changes here are fairly granular so I decided to add a new page to
describe the various ways to search and filter dashboards to help users
locate the information. Note that this feature will also be described on
its own in the release highlights.

Closes: elastic/platform-docs-team#431

- Add a new page dedicated to sorting and filtering dashboards to
mention the various ways to do it, including the new filter by creator
<img width="1187" alt="image"
src="https://github.com/user-attachments/assets/c0e3924f-ff0a-4bbb-92d2-776baf243197">
<img width="1421" alt="image"
src="https://github.com/user-attachments/assets/c21320bf-ee31-41bb-a0a4-693f7514b462">

- Mention in Save section of the dashboard creation page
<img width="773" alt="image"
src="https://github.com/user-attachments/assets/6373c384-d427-4502-ba4a-e12f28057224">

- Mention in parent page of Dashboard and visualizations section (Open
dashboard section)
<img width="1215" alt="image"
src="https://github.com/user-attachments/assets/da43222c-a28c-46ca-8f0e-d415793487af">

---------

Co-authored-by: Anton Dosov <[email protected]>
  • Loading branch information
florent-leborgne and Dosant authored Jul 31, 2024
1 parent 06c18d9 commit 0057953
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 1 deletion.
5 changes: 5 additions & 0 deletions docs/user/dashboard/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,11 @@ When you create a dashboard, you are automatically in edit mode and can make cha

* To open an existing dashboard, click the dashboard *Title* you want to open.
+
TIP: When looking for a specific dashboard, you can filter them by tag or by creator, or search the list based on their name and description. Note that the creator information is only available for dashboards created on or after version 8.14.
+
When you open an existing dashboard, you are in view mode. To make changes to the dashboard, click *Edit* in the toolbar.


[float]
[[create-panels-with-lens]]
=== Create and add panels
Expand Down Expand Up @@ -450,4 +453,6 @@ include::create-panels-with-editors.asciidoc[]

include::make-dashboards-interactive.asciidoc[]

include::find-dashboards.asciidoc[]

include::dashboard-troubleshooting.asciidoc[]
29 changes: 29 additions & 0 deletions docs/user/dashboard/find-dashboards.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[[find-dashboards]]
== Search and filter dashboards

When looking for specific dashboards to open or share, several actions are available to you to help you find them quicker.

**Search by name, description, or tag**

On your list of **Dashboards**, use the search field to look for specific terms. These terms will be highlighted in real time in your dashboard list to help you locate what's relevant to you.

**Filter by tag**

When creating or editing dashboards, you can assign them tags that allow you to retrieve them faster in the future.

On your dashboard list, you have an option that lets you filter dashboards in or out based on their tags.

**Filter by creator**

The user who created or imported a dashboard is identified as the dashboard's **creator**. This information is visible right from the dashboard list, and you can filter that list by creator.

Similarly, managed dashboards created by integrations are identified as created by Elastic.

NOTE: The creator information is only available for dashboards created on or after version 8.14. For dashboards from previous versions, the creator is empty.

image::images/dashboard-filter-by-creator.png[Option to filter the list of dashboards by creator]

**Sort by name or last update date**

You can sort the dashboard list based on their name or their last update date.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -376,4 +376,6 @@ Now that you have a complete overview of your web server data, save the dashboar

. Select *Store time with dashboard*.

. Click *Save*.
. Click *Save*. You will be identified as the **creator** of the dashboard. If you or another user edit the dashboard, you can also view the **last editor** when checking the dashboard information.

image::images/dashboard-creator-editor.png[Information panel of a dashboard showing its creator and last editor]

0 comments on commit 0057953

Please sign in to comment.