Skip to content

Commit 0274e14

Browse files
joepeeplesbenironsidejmikell821
authored
[DOCS] New grouped navigation side menu (#2088)
* Add to Advanced Settings Also slight reorder to better match UI * Add new nested topic, images * Corrects name of advanced setting * Apply suggestions from code review Co-authored-by: benironside <91905639+benironside@users.noreply.github.com> * Update docs/getting-started/advanced-setting.asciidoc * Crop image * Update docs/getting-started/grouped-nav-ui.asciidoc * Apply suggestions from Janeen's review Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com> Co-authored-by: benironside <91905639+benironside@users.noreply.github.com> Co-authored-by: Janeen Mikell-Straughn <57149392+jmikell821@users.noreply.github.com>
1 parent 0619d16 commit 0274e14

File tree

5 files changed

+38
-10
lines changed

5 files changed

+38
-10
lines changed

docs/getting-started/advanced-setting.asciidoc

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
The advanced settings determine:
55

66
* Which indices {es-sec} uses to retrieve data
7+
* {ml-cap} anomaly score display threshold
8+
* The navigation menu style used throughout the {security-app}
79
* Whether the news feed is displayed on the <<overview-ui>>
810
* The default time interval used to filter {es-sec} pages
911
* The default {es-sec} pages refresh time
10-
* {ml-cap} anomaly score display threshold
1112
* Which IP reputation links appear on <<network-page-overview, IP detail>>
1213
pages
1314
* Whether cross-cluster search (CCS) privilege warnings are displayed
@@ -84,6 +85,21 @@ Kibana transmits certain information about Elastic Security when users interact
8485

8586
To learn more, refer to our https://www.elastic.co/legal/privacy-statement[Privacy Statement].
8687

88+
[discrete]
89+
== Set machine learning score threshold
90+
91+
When security <<machine-learning, {ml} jobs>> are enabled, this setting
92+
determines the threshold above which anomaly scores appear in {es-sec}:
93+
94+
* `securitySolution:defaultAnomalyScore`
95+
96+
[discrete]
97+
== Enable grouped navigation
98+
99+
The `securitySolution:enableGroupedNav` setting enables the grouped navigation menu for {elastic-sec}, which groups related pages and highlights commonly visited areas for a streamlined experience.
100+
101+
By default, the {security-app} uses the legacy navigation menu; turn on `securitySolution:enableGroupedNav` to use the grouped navigation menu.
102+
87103
[discrete]
88104
== Modify news feed settings
89105

@@ -108,14 +124,6 @@ NOTE: Refer to {ref}/common-options.html[Date Math] for information about the
108124
syntax. The UI {kibana-ref}/set-time-filter.html[time filter] overrides the
109125
default values.
110126

111-
[discrete]
112-
== Set machine learning score threshold
113-
114-
When security <<machine-learning, {ml} jobs>> are enabled, this setting
115-
determines the threshold above which anomaly scores are displayed in {es-sec}:
116-
117-
* `securitySolution:defaultAnomalyScore`
118-
119127
[discrete]
120128
[[ip-reputation-links]]
121129
== Display reputation links on IP detail pages
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[[grouped-nav-ui]]
2+
= Grouped navigation menu
3+
4+
{elastic-sec}'s grouped navigation menu groups related pages and highlights commonly visited areas for a streamlined experience.
5+
6+
NOTE: By default, the {security-app} uses the legacy navigation menu. To enable grouped navigation, go to *{kib}* -> *{stack-manage-app}* -> *Advanced Settings*, then turn on `securitySolution:enableGroupedNav`.
7+
8+
[role="screenshot"]
9+
image::images/grouped-nav-ui.png[width=75%][height=75%][Overview of grouped navigation UI]
10+
11+
The side navigation menu contains direct links and expandable groups, identified by the group icon (image:images/group-icon.png[Group icon,16,16]).
12+
13+
* Click top-level links to go directly to pages that are essential for detection and investigation workflows (*Alerts*, *Timelines*, and *Cases*).
14+
15+
* Click a group's name to go to its landing page, with links and information for related pages.
16+
17+
* Click a group's icon (image:images/group-icon.png[Group icon,16,15]) to open its flyout menu. This displays the same links and information as the landing page, but without navigating away from the current page.
18+
19+
* Use the *Manage* group to configure {elastic-sec} for various use cases, such as SIEM and endpoint management.
447 Bytes
Loading
160 KB
Loading

docs/getting-started/security-ui.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
[[es-ui-overview]]
2-
[chapter,role="xpack"]
32
= Elastic Security UI
43

54
The {security-app} is a highly interactive workspace designed for security analysts that provides a clear overview of events and alerts from your environment. You can use the interactive UI to drill down into areas of interest.
@@ -270,3 +269,5 @@ image::images/timeline-accessiblity-shifting-keyboard-focus.gif[width=100%][heig
270269

271270
[role="screenshot"]
272271
image::images/timeline-accessiblity-page-up-n-down.gif[width=100%][height=100%][Demo that shows how to to scroll through the page]
272+
273+
include::grouped-nav-ui.asciidoc[leveloffset=+1]

0 commit comments

Comments
 (0)