[DOCS] Replace table of links with single link to Obs alerting docs #177525
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
cc @vinaychandrasekhar because this change was based on his input. |
21 tasks
dedemorton
changed the title
|
Marking this as ready for review, but would still like input on my list of open questions. Thanks! |
dedemorton
added
release_note:skip
|
@elasticmachine merge upstream |
lcawl
changed the title
|
With respect to your outstanding questions:
You're right, it looks like you can't create any of the security rules in the Stack Management Rules app, so your suggestion sounds good to me!
We're gradually removing occurrences of "trigger" and "execute" as much as possible from the Rules and Connectors apps and docs, so not "trigger alerts". |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 11, 2024
…lastic#177525) ## Summary Replaces the categorized table of links with a single link to the observability alerting docs because this table is likely to get stale over time (in fact, it already is stale). The change looks like this when rendered in HTML:  Notes/open issues: - [x] The [main alerting page](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html) for Kibana now has links to related alerting documentation, but is it clear that those links point to docs that describe how to manage alerts from those apps? The link text seems maybe not descriptive enough and might be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this as-is because I think the feedback we received initially about the lack of links was before the links were added._ - [x] In the intro, I feel a thought might be missing from this statement: "For information on creating security rules, refer to Create a detection rule." Should this instead say something like: "Security rules must be defined in the Security app. For more information, refer to the security docs about creating a detection rule." _RESOLVED_ - [x] I think the descriptions about each app's alerting capabilities should be more consistent, but I don't want to rewrite other folk's sections. So I have aligned my description with the security section, for better or worse. It's hard to make this info consistent when each solution/app is doing its own thing with alerting. _DEFERRED: We will fix inconsistencies later._ - [x] Is it correct to say "create alerts" rather than something like "trigger alerts" or "generate alerts"? _RESOLVED: Will keep as "create" for now since the UI is not using "trigger."_ ### Checklist n/a cc @lcawl Can you help me sort through my list of open issues? Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit 881980a)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 11, 2024
…lastic#177525) ## Summary Replaces the categorized table of links with a single link to the observability alerting docs because this table is likely to get stale over time (in fact, it already is stale). The change looks like this when rendered in HTML:  Notes/open issues: - [x] The [main alerting page](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html) for Kibana now has links to related alerting documentation, but is it clear that those links point to docs that describe how to manage alerts from those apps? The link text seems maybe not descriptive enough and might be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this as-is because I think the feedback we received initially about the lack of links was before the links were added._ - [x] In the intro, I feel a thought might be missing from this statement: "For information on creating security rules, refer to Create a detection rule." Should this instead say something like: "Security rules must be defined in the Security app. For more information, refer to the security docs about creating a detection rule." _RESOLVED_ - [x] I think the descriptions about each app's alerting capabilities should be more consistent, but I don't want to rewrite other folk's sections. So I have aligned my description with the security section, for better or worse. It's hard to make this info consistent when each solution/app is doing its own thing with alerting. _DEFERRED: We will fix inconsistencies later._ - [x] Is it correct to say "create alerts" rather than something like "trigger alerts" or "generate alerts"? _RESOLVED: Will keep as "create" for now since the UI is not using "trigger."_ ### Checklist n/a cc @lcawl Can you help me sort through my list of open issues? Co-authored-by: Kibana Machine <[email protected]> (cherry picked from commit 881980a)
💔 Some backports could not be created
Note: Successful backport PRs will be merged automatically after passing CI. Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
kibanamachine
added a commit
that referenced
this pull request
Mar 11, 2024
… docs (#177525) (#178427) # Backport This will backport the following commits from `main` to `8.12`: - [[DOCS] Replace table of links with single link to Obs alerting docs (#177525)](#177525) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"DeDe Morton","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-11T18:34:31Z","message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","v8.14.0","v8.12.3"],"title":"[DOCS] Replace table of links with single link to Obs alerting docs","number":177525,"url":"https://github.com/elastic/kibana/pull/177525","mergeCommit":{"message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/177525","number":177525,"mergeCommit":{"message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},{"branch":"8.12","label":"v8.12.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: DeDe Morton <[email protected]>
kibanamachine
added a commit
that referenced
this pull request
Mar 11, 2024
… docs (#177525) (#178428) # Backport This will backport the following commits from `main` to `8.13`: - [[DOCS] Replace table of links with single link to Obs alerting docs (#177525)](#177525) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"DeDe Morton","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-11T18:34:31Z","message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","v8.14.0","v8.12.3"],"title":"[DOCS] Replace table of links with single link to Obs alerting docs","number":177525,"url":"https://github.com/elastic/kibana/pull/177525","mergeCommit":{"message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},"sourceBranch":"main","suggestedTargetBranches":["8.12"],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/177525","number":177525,"mergeCommit":{"message":"[DOCS] Replace table of links with single link to Obs alerting docs (#177525)\n\n## Summary\r\n\r\nReplaces the categorized table of links with a single link to the\r\nobservability alerting docs because this table is likely to get stale\r\nover time (in fact, it already is stale).\r\n\r\nThe change looks like this when rendered in HTML:\r\n\r\n\r\n\r\n\r\n\r\nNotes/open issues:\r\n- [x] The [main alerting\r\npage](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)\r\nfor Kibana now has links to related alerting documentation, but is it\r\nclear that those links point to docs that describe how to manage alerts\r\nfrom those apps? The link text seems maybe not descriptive enough and\r\nmight be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this\r\nas-is because I think the feedback we received initially about the lack\r\nof links was before the links were added._\r\n- [x] In the intro, I feel a thought might be missing from this\r\nstatement: \"For information on creating security rules, refer to Create\r\na detection rule.\" Should this instead say something like: \"Security\r\nrules must be defined in the Security app. For more information, refer\r\nto the security docs about creating a detection rule.\" _RESOLVED_\r\n- [x] I think the descriptions about each app's alerting capabilities\r\nshould be more consistent, but I don't want to rewrite other folk's\r\nsections. So I have aligned my description with the security section,\r\nfor better or worse. It's hard to make this info consistent when each\r\nsolution/app is doing its own thing with alerting. _DEFERRED: We will\r\nfix inconsistencies later._\r\n- [x] Is it correct to say \"create alerts\" rather than something like\r\n\"trigger alerts\" or \"generate alerts\"? _RESOLVED: Will keep as \"create\"\r\nfor now since the UI is not using \"trigger.\"_\r\n\r\n### Checklist\r\n\r\nn/a\r\n\r\ncc @lcawl Can you help me sort through my list of open issues?\r\n\r\nCo-authored-by: Kibana Machine <[email protected]>","sha":"881980aea01e15ff20f8fbbe01912ae8d547d075"}},{"branch":"8.12","label":"v8.12.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: DeDe Morton <[email protected]>
1 task
dedemorton
added a commit
that referenced
this pull request
Mar 11, 2024
## Summary Pushing a commit that _should_ have been part of #177525 ### Checklist Delete any items that are not applicable to this PR. - [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)
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this pull request
Mar 11, 2024
## Summary Pushing a commit that _should_ have been part of elastic#177525 ### Checklist Delete any items that are not applicable to this PR. - [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 5e09b74)
kibanamachine
added a commit
that referenced
this pull request
Mar 11, 2024
# Backport This will backport the following commits from `main` to `8.13`: - [Add statement about defining security rules (#178463)](#178463) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"DeDe Morton","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-11T22:59:38Z","message":"Add statement about defining security rules (#178463)\n\n## Summary\r\n\r\nPushing a commit that _should_ have been part of\r\nhttps://github.com//pull/177525\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\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":"5e09b74e9cde6d66a290a15e5a41799d462366ef","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:all-open","v8.14.0"],"title":"Add statement about defining security rules","number":178463,"url":"https://github.com/elastic/kibana/pull/178463","mergeCommit":{"message":"Add statement about defining security rules (#178463)\n\n## Summary\r\n\r\nPushing a commit that _should_ have been part of\r\nhttps://github.com//pull/177525\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\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":"5e09b74e9cde6d66a290a15e5a41799d462366ef"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/178463","number":178463,"mergeCommit":{"message":"Add statement about defining security rules (#178463)\n\n## Summary\r\n\r\nPushing a commit that _should_ have been part of\r\nhttps://github.com//pull/177525\r\n\r\n### Checklist\r\n\r\nDelete any items that are not applicable to this PR.\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":"5e09b74e9cde6d66a290a15e5a41799d462366ef"}}]}] BACKPORT--> Co-authored-by: DeDe Morton <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Replaces the categorized table of links with a single link to the observability alerting docs because this table is likely to get stale over time (in fact, it already is stale).
The change looks like this when rendered in HTML:
Notes/open issues:
Checklist
n/a
cc @lcawl Can you help me sort through my list of open issues?