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

Jump to bottom

[Rule Details] - Update rule details data view id text #164494

Merged
merged 6 commits into from
Aug 28, 2023
Merged

[Rule Details] - Update rule details data view id text #164494

merged 6 commits into from
Aug 28, 2023

Conversation

yctercero
Copy link
Contributor

@yctercero yctercero commented Aug 22, 2023 •
edited by kibanamachine
Loading

Resolves: #164828
Related UX writing issue: https://github.com/elastic/ux-writing/issues/46

Summary

In rule details page, when a rule has a data view selected, two labels show up as "Data View". This appears to be a bug, as one of those labels should be "Data view ID" and another should be "Data view index pattern".

Thanks to @MadameSheema @nikitaindik for finding this.

Before

image

After

Screenshot 2023-08-26 at 19 30 54

Checklist

@yctercero yctercero self-assigned this Aug 22, 2023
@yctercero yctercero requested a review from a team as a code owner August 22, 2023 18:06
@yctercero yctercero requested a review from jpdjere August 22, 2023 18:06
@yctercero yctercero added Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team Team:Detection Engine Security Solution Detection Engine Area v8.10.0 v8.11.0 v8.9.2 bug Fixes for quality problems that affect the customer experience release_note:skip Skip the PR/issue when compiling release notes labels Aug 22, 2023
@banderror banderror added Feature:Rule Details Security Solution Detection Rule Details page and removed Feature:Rule Management Security Solution Detection Rule Management area labels Aug 23, 2023
@yctercero
Copy link
Contributor Author

@elasticmachine merge upstream

1 similar comment
@yctercero
Copy link
Contributor Author

@elasticmachine merge upstream

@yctercero yctercero mentioned this pull request Aug 25, 2023
Closed
@nastasha-solomon nastasha-solomon added the ui-copy Review of UI copy with docs team is recommended label Aug 25, 2023
@nikitaindik nikitaindik force-pushed the rule_details_text branch 2 times, most recently from 021b7e8 to bc3f588 Compare August 26, 2023 16:04
@nikitaindik nikitaindik self-assigned this Aug 26, 2023
@nikitaindik
Copy link
Contributor

nikitaindik commented Aug 26, 2023 •
edited
Loading

Changed the index pattern field label to "Data view index pattern", but left the ID field label as just "Data view" because it's also used on the Create Rule form.

Screenshot 2023-08-25 at 01 02 09

If I would change it to "Data view ID", it would confuse users on the Create Rule page because there it's used for an index pattern dropdown (title field of the data view object). Refactoring it would require some effort. At some point we are going to rewrite the Rule Details page to use new lightweight section components (About, Definition, Schedule...) and at that point we can safely rename it to "Data view ID" because there will be no connection with the create form.

@nikitaindik
Copy link
Contributor

@elasticmachine merge upstream

jpdjere
jpdjere approved these changes Aug 28, 2023
View reviewed changes
Copy link
Contributor

@jpdjere jpdjere left a comment

Choose a reason for hiding this comment

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

Codewise LGTM 👍

I think your decision here makes sens, but I just want to double check if the changes were aligned with the UX team. I know there was a Slack discussion somewhere but lost the result or final decision that came out of it.

@nikitaindik
Copy link
Contributor

Codewise LGTM 👍

I think your decision here makes sens, but I just want to double check if the changes were aligned with the UX team. I know there was a Slack discussion somewhere but lost the result or final decision that came out of it.

Thanks for the review! Going to discuss the exact wording with the UX team later today. There's also a related issue: https://github.com/elastic/ux-writing/issues/46

@nikitaindik nikitaindik enabled auto-merge (squash) August 28, 2023 15:32
@nikitaindik
Copy link
Contributor

After discussing the technical limitations with @nastasha-solomon, we settled on labeling "Data view" + "Data view index pattern".

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id before after diff
securitySolution 12.5MB 12.5MB +818.0B

History

  • 💛 Build #153861 was flaky 0f41d344459896f69bd6329fb358d6f522b052cf
  • 💔 Build #153840 failed a8793a668c7d076f956713c4d5f6f2da9749e235
  • 💚 Build #153829 succeeded bc3f5888a7ec559d636c7016723484428258a4c1
  • 💛 Build #153816 was flaky 021b7e834abea226faffb2a10ce50d3eaaa8f8f0
  • 💔 Build #153735 failed 537ca901a7ae4bf2464b4abf42b8350526e0e120
  • 💔 Build #153693 failed fb3427d1795cbd504d771a4037a53fedf768a478

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @yctercero @nikitaindik

@nikitaindik nikitaindik merged commit 31e9557 into elastic:main Aug 28, 2023
@kibanamachine kibanamachine mentioned this pull request Aug 28, 2023
Merged
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 28, 2023
@yctercero
[Rule Details] - Update rule details data view id text (elastic#164494)
4b7594b 
**Resolves: elastic#164828
**Related UX writing issue:
elastic/ux-writing#46

## Summary

In rule details page, when a rule has a data view selected, two labels
show up as "Data View". This appears to be a bug, as one of those labels
should be "Data view ID" and another should be "Data view index
pattern".

Thanks to @MadameSheema @nikitaindik for finding this.

### Before

![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)

### After
<img width="808" alt="Screenshot 2023-08-26 at 19 30 54"
src="https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58">

### 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)

---------

Co-authored-by: Nikita Indik <nikita.indik@elastic.co>
(cherry picked from commit 31e9557)
@kibanamachine
Copy link
Contributor

💔 Some backports could not be created

Status Branch Result
✅ 8.10
❌ 8.9 Backport failed because of merge conflicts

Note: Successful backport PRs will be merged automatically after passing CI.

Manual backport

To create the backport manually run:

node scripts/backport --pr 164494

Questions ?

Please refer to the Backport tool documentation

@nikitaindik nikitaindik mentioned this pull request Aug 28, 2023
Merged
@nikitaindik
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 8.9

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

nikitaindik pushed a commit to nikitaindik/kibana that referenced this pull request Aug 28, 2023
@yctercero @nikitaindik
[Rule Details] - Update rule details data view id text (elastic#164494)
85684db 
**Resolves: elastic#164828
**Related UX writing issue:
elastic/ux-writing#46

In rule details page, when a rule has a data view selected, two labels
show up as "Data View". This appears to be a bug, as one of those labels
should be "Data view ID" and another should be "Data view index
pattern".

Thanks to @MadameSheema @nikitaindik for finding this.

![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)

<img width="808" alt="Screenshot 2023-08-26 at 19 30 54"
src="https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58">

- [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)

---------

Co-authored-by: Nikita Indik <nikita.indik@elastic.co>
(cherry picked from commit 31e9557)
kibanamachine added a commit that referenced this pull request Aug 28, 2023
@kibanamachine @yctercero
[8.10] [Rule Details] - Update rule details data view id text (#164494)…
52d4bc4 
… (#165015)

# Backport

This will backport the following commits from `main` to `8.10`:
- [[Rule Details] - Update rule details data view id text
(#164494)](#164494)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Yara
Tercero","email":"yctercero@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-08-28T16:29:00Z","message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","Team:Detection
Rule Management","ui-copy","Feature:Rule Details","Team:Detection
Engine","v8.10.0","v8.11.0","v8.9.2"],"number":164494,"url":"https://github.com/elastic/kibana/pull/164494","mergeCommit":{"message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/164494","number":164494,"mergeCommit":{"message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d"}},{"branch":"8.9","label":"v8.9.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Yara Tercero <yctercero@users.noreply.github.com>
nikitaindik added a commit that referenced this pull request Aug 28, 2023
@nikitaindik @yctercero
[8.9] [Rule Details] - Update rule details data view id text (#164494) (
098c0aa 
#165021)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[Rule Details] - Update rule details data view id text
(#164494)](#164494)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Yara
Tercero","email":"yctercero@users.noreply.github.com"},"sourceCommit":{"committedDate":"2023-08-28T16:29:00Z","message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["bug","release_note:skip","Team:Detection
Rule Management","ui-copy","Feature:Rule Details","Team:Detection
Engine","v8.10.0","v8.11.0","v8.9.2"],"number":164494,"url":"https://github.com/elastic/kibana/pull/164494","mergeCommit":{"message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/165015","number":165015,"state":"OPEN"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/164494","number":164494,"mergeCommit":{"message":"[Rule
Details] - Update rule details data view id text
(#164494)\n\n**Resolves:
https://github.com/elastic/kibana/issues/164828**\r\n**Related UX
writing
issue:\r\nhttps://github.com/elastic/ux-writing/issues/46**\r\n\r\n##
Summary\r\n\r\nIn rule details page, when a rule has a data view
selected, two labels\r\nshow up as \"Data View\". This appears to be a
bug, as one of those labels\r\nshould be \"Data view ID\" and another
should be \"Data view index\r\npattern\".\r\n\r\nThanks to @MadameSheema
@nikitaindik for finding this. \r\n\r\n### Before
\r\n\r\n![image](https://github.com/elastic/kibana/assets/10927944/8ac8b6d4-1005-4c03-a71a-31216a1287c5)\r\n\r\n###
After\r\n<img width=\"808\" alt=\"Screenshot 2023-08-26 at 19 30
54\"\r\nsrc=\"https://github.com/elastic/kibana/assets/15949146/b511bf92-0e90-4455-834c-36b8e75b2a58\">\r\n\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)\r\n\r\n---------\r\n\r\nCo-authored-by:
Nikita Indik
<nikita.indik@elastic.co>","sha":"31e95574ae6d8cfa9e0ba4595e1068e9391b423d"}},{"branch":"8.9","label":"v8.9.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Yara Tercero <yctercero@users.noreply.github.com>
@banderror banderror added release_note:fix and removed release_note:skip Skip the PR/issue when compiling release notes labels Sep 1, 2023
@banderror banderror mentioned this pull request Sep 1, 2023
Merged
This was referenced Oct 1, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jpdjere jpdjere jpdjere approved these changes

Assignees

@yctercero yctercero

@nikitaindik nikitaindik

Labels
bug Fixes for quality problems that affect the customer experience Feature:Rule Details Security Solution Detection Rule Details page release_note:fix Team:Detection Engine Security Solution Detection Engine Area Team:Detection Rule Management Security Detection Rule Management Team ui-copy Review of UI copy with docs team is recommended v8.9.2 v8.10.0 v8.11.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Security Solution]Data view details twice in Rule Definition section
7 participants
@yctercero @nikitaindik @kibana-ci @kibanamachine @jpdjere @banderror @nastasha-solomon