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.

Sign up for GitHub

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

Documents how to change the default security index #4695

Merged
merged 5 commits into from
Jan 31, 2024
Merged

Documents how to change the default security index #4695

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
760e85e
First draft
benironside Jan 26, 2024
c1bf4be
incorporates feedback
benironside Jan 30, 2024
38eb1dc
Merge branch 'main' into 4653-alert-defaultIndex-instructions
benironside Jan 30, 2024
f87a1d6
Update docs/getting-started/data-views-in-sec.asciidoc
benironside Jan 30, 2024
964f668
Update docs/getting-started/data-views-in-sec.asciidoc
benironside Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/getting-started/data-views-in-sec.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,17 @@ image::images/dataview-button-highlighted.png[image highlighting how to open the
[discrete]
== Create or modify a {data-source}

You can temporarily modify the active {data-source} from the *{data-source-cap}* menu by clicking *Advanced options*, then adding or removing index patterns.
To learn how to modify the default **Security Default Data View**, refer to <<update-sec-indices, Update default {elastic-sec} indices>>.

To learn how to modify, create, or delete another {data-source} refer to {apm-app-ref}/data-views.html[{kib} {data-sources-cap}].

You can also temporarily modify the active {data-source} from the *{data-source-cap}* menu by clicking *Advanced options*, then adding or removing index patterns.

image::images/dataview-filter-example.gif[video showing how to filter the active data view]

This only allows you to add index patterns that match indices that currently contain data (other index patterns are unavailable). Note that any changes made are saved in the current browser window and won't persist if you open a new tab.

To permanently modify a {data-source}, delete an existing {data-source} or create a new one, you need the required permissions.
To learn more, refer to {apm-app-ref}/data-views.html[{kib} {data-sources-cap}].
NOTE: You cannot update the data view for the Alerts page. It always shows data from `.alerts-security.alerts-default`.
Copy link
Contributor

Choose a reason for hiding this comment

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

@e40pud can we tweak the UI copy so it aligns with this note? The current copy could be interpreted as: you must go elsewhere to update the data view for the Alerts page.

Screenshot 2024-01-30 at 2 55 42 PM

If it's still possible to change the copy, I'd suggest this:

You can't modify the data view for the Alerts page.

If that version is too blunt and overly formal, here's a slightly softer version:

This page's data view can't be adjusted.

Copy link
Contributor

Choose a reason for hiding this comment

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

It is not bound to Alerts page only. Same happens on rule details page. Also, there is another similar message that we show on the timeline. So, general message looks better to me.

Screen.Recording.2024-01-31.at.16.47.22.mov

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah, interesting. Thanks for pointing out these other areas @e40pud -- I wasn't aware of them. Would it be ok if we continued this conversation in https://github.com/elastic/security-docs/issues/4718 so that we're not blocking this doc issue from being closed and merged?


[discrete]
[[default-data-view-security]]
Expand Down