[UI copy]: [Security Solution] Flyout navigation copy #5484
Comments
|
Thanks for filing this, @christineweng! Please find my suggestions and questions below.
I think it'd be a good idea to follow what's in the rule details flyout (see image below). On a related note, would this be a good opportunity to tweak the existing copy for the rule details preview? If so, here's what I'm thinking: Rule previewpreview banner: 
If you were ok with tweaking the existing rule preview copy, you should apply that to the user and host details flyout copy like so: Host previewpreview banner: User previewpreview banner: If it's not possible to tweak the rule preview copy, here's what I'd suggest instead for the host and user preview flyouts: Host previewpreview banner: User previewpreview banner:
This just needs a minor change:
In the current copy, what does "this flyout" refer to?
Same question about "this flyout".
Even though users are technically opening another flyout, it's more useful for them to understand what they'll find in the newly opened flyout. In other words, we should describe the result of the action (they'll find more details on the alert), not the action itself (they're opening a new flyout). In case you're interested, you can find more info on writing linked text here. I recommend changing the footer copy to one of the following:
|
i think it is referencing to this preview's full flyout - distinguishing what you are seeing is a preview, but you can also see an actual/full form flyout by clicking this link |
|
Gotcha, and thanks for the example recording in Slack, @christineweng. Instead of telling users to switch to another flyout, can we provide them with a way to do it? For example, in your example video here, the copy tells users to open the alert details flyout to view investigation guides. I like the directness of the copy, but would prefer for it to be more interactive. Is it possible to make the text
Access is another option if you don't like "find" as the action users would take. If you'd prefer to go with plain text because it's easier to set up and maintain, here are my suggestions for the copy:
I'm not a fan of using "open" in the preview copy and "show" in the footer copy, but they're close enough that it shouldn't be too much of a stretch for users to make that connection. Let me know your thoughts and if you still want to workshop the text. |
|
Great, thanks @nastasha-solomon! The interaction (include a link and then it opens the full flyout) was suggested by UIUX, but there were considerations around maintenance and the flow. We will have more time to investigate and improve the flow in 8.16, so I'm going with plain text to keep it simple for 8.15. |
|
@nastasha-solomon the new copy are reflected in
|
## Summary Copy update per docs team's review [here](elastic/security-docs#5484 (comment)): > Host preview > preview banner: `Preview host details` > link in the footer: `Show full host details` > > User preview > preview banner: `Preview user details` > link in the footer: `Show full user details` ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
|
Changes merged, so closing this issue. |
## Summary Copy update per docs team's review [here](elastic/security-docs#5484 (comment)): > Host preview > preview banner: `Preview host details` > link in the footer: `Show full host details` > > User preview > preview banner: `Preview user details` > link in the footer: `Show full user details` ### Checklist - [x] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md) (cherry picked from commit 64738fb)
…) (#189095) # Backport This will backport the following commits from `main` to `8.15`: - [[Security solution] Entity previews flyout copy refresh (#187430)](#187430) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"christineweng","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-07-09T16:40:27Z","message":"[Security solution] Entity previews flyout copy refresh (#187430)\n\n## Summary\r\n\r\nCopy update per docs team's review\r\n[here](https://github.com/elastic/security-docs/issues/5484#issuecomment-2197358502):\r\n\r\n> Host preview\r\n> preview banner: `Preview host details`\r\n> link in the footer: `Show full host details`\r\n> \r\n> User preview\r\n> preview banner: `Preview user details`\r\n> link in the footer: `Show full user details`\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"64738fb7fad2391cc0c73b5a9f84090fb35edd56","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:skip","Team:Threat Hunting","Team:Threat Hunting:Investigations","v8.15.0","v8.16.0"],"number":187430,"url":"https://github.com/elastic/kibana/pull/187430","mergeCommit":{"message":"[Security solution] Entity previews flyout copy refresh (#187430)\n\n## Summary\r\n\r\nCopy update per docs team's review\r\n[here](https://github.com/elastic/security-docs/issues/5484#issuecomment-2197358502):\r\n\r\n> Host preview\r\n> preview banner: `Preview host details`\r\n> link in the footer: `Show full host details`\r\n> \r\n> User preview\r\n> preview banner: `Preview user details`\r\n> link in the footer: `Show full user details`\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"64738fb7fad2391cc0c73b5a9f84090fb35edd56"}},"sourceBranch":"main","suggestedTargetBranches":["8.15"],"targetPullRequestStates":[{"branch":"8.15","label":"v8.15.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/187430","number":187430,"mergeCommit":{"message":"[Security solution] Entity previews flyout copy refresh (#187430)\n\n## Summary\r\n\r\nCopy update per docs team's review\r\n[here](https://github.com/elastic/security-docs/issues/5484#issuecomment-2197358502):\r\n\r\n> Host preview\r\n> preview banner: `Preview host details`\r\n> link in the footer: `Show full host details`\r\n> \r\n> User preview\r\n> preview banner: `Preview user details`\r\n> link in the footer: `Show full user details`\r\n\r\n### Checklist\r\n\r\n- [x] Any text added follows [EUI's writing\r\nguidelines](https://elastic.github.io/eui/#/guidelines/writing), uses\r\nsentence case text and includes [i18n\r\nsupport](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)","sha":"64738fb7fad2391cc0c73b5a9f84090fb35edd56"}}]}] BACKPORT-->
Description
We are introducing the preview navigation in the exiting alert flyout experience. In 8.15 (currently behind a feature flag), a user can click on a host name, and a preview of the host flyout will appear. This allows the user to see the host information without leaving the original alert context. The same is applied to user name (opens a user entity flyout in preview mode), and alerts (opens another alert in preview mode).
The preview mode disallows any expand capability, but there is a footer with a link to open an "actual" flyout.
Requsting a copy review of the text added:
Host preview
Preview hostOpen host details flyout(orReplace with this flyoutfrom design)User preview
Preview userOpen user details flyout(orReplace with this flyoutfrom design)Alert preview
Preview alertYou are currently in preview mode. Switch to this flyout to access all expandable options.You are currently in preview mode. Switch to this flyout to access all expandable options.Open alert details flyout(orReplace with this flyoutfrom design)Related links / assets
Please include each of the following, if applicable:
Figma link(s):
Github epic link(s): https://github.com/elastic/security-team/issues/9510
PRs:
elastic/kibana#186850
elastic/kibana#186857
Github issue link(s):
How to find the text in a production environment:
Testing environment information:
NOTE: To keep sensitive information such as credentials secure, do not include it in this form.
Which documentation set does this change impact?
ESS and serverless
Feature differences
Same
Software version
kibana 8.15
Collaborators
PM: Paul Ewing
Designer: Sergei Sivukhin, Pavel Manko
Developer: Christine Weng
Others (if applicable):
Timeline / deliverables
This feature goes in 8.15 (FF is July 2), but I can update just the copy during the BCs, ideally before July 12.
The text was updated successfully, but these errors were encountered: