[Alerting v2][Serverless]: Docs for initial public release #5528
Draft
nastasha-solomon wants to merge 2 commits intomainfrom
Draft
[Alerting v2][Serverless]: Docs for initial public release #5528nastasha-solomon wants to merge 2 commits intomainfrom
nastasha-solomon wants to merge 2 commits intomainfrom
Conversation
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary <!-- Describe what your PR changes or improves. If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change. --> Fixes elastic/docs-content-internal#919. First draft of v2 alerting docs. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes - [ ] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> Cursor + Claude
Contributor
Vale Linting ResultsSummary: 5 warnings, 28 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/alerting-overview.md | 12 | Elastic.Spelling | 'geofencing' is a possible misspelling. |
| explore-analyze/alerting/choose-an-alerting-system.md | 34 | Elastic.Spelling | 'queryability' is a possible misspelling. |
| explore-analyze/alerting/kibana-alerting-v2/author-rules/rule-settings.md | 29 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| explore-analyze/alerting/kibana-alerting-v2/author-rules/rule-settings.md | 37 | Elastic.EndPuntuaction | Don't end headings with punctuation. |
| troubleshoot/elasticsearch/mapping-explosion.md | 37 | Elastic.Spelling | 'Javascript' is a possible misspelling. |
💡 Suggestions (28)
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/deploy/cloud-on-k8s/k8s-service-mesh-istio.md | 15 | Elastic.Versions | Use 'or later' instead of 'or newer' when referring to versions. |
| deploy-manage/production-guidance/kibana-task-manager-scaling-considerations.md | 15 | Elastic.HeadingColons | Capitalize ': p'. |
| deploy-manage/users-roles/cluster-or-deployment-auth/quickstart.md | 25 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/alerting-overview.md | 17 | Elastic.Wordiness | Consider using 'act' instead of 'take action'. |
| explore-analyze/alerting/choose-an-alerting-system.md | 17 | Elastic.Ellipses | In general, don't use an ellipsis. |
| explore-analyze/alerting/choose-an-alerting-system.md | 21 | Elastic.FirstPerson | Use caution when using first-person pronouns such as 'my.' |
| explore-analyze/alerting/kibana-alerting-v1/alerting-common-issues-v1.md | 84 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v1/alerting-getting-started-v1.md | 26 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v1/alerting-getting-started-v1.md | 30 | Elastic.Wordiness | Consider using 'these' instead of 'all of these'. |
| explore-analyze/alerting/kibana-alerting-v1/alerting-troubleshooting-v1.md | 35 | Elastic.Wordiness | Consider using 'also' instead of 'In addition'. |
| explore-analyze/alerting/kibana-alerting-v1/create-manage-rules-v1.md | 58 | Elastic.Semicolons | Use semicolons judiciously. |
| explore-analyze/alerting/kibana-alerting-v1/create-manage-rules-v1.md | 130 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v1/create-manage-rules-v1.md | 132 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v1/rule-types-v1.md | 16 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v1/view-alerts-v1.md | 105 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v2/before-you-begin/set-up.md | 44 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v2/manage-alerts/investigate-respond.md | 8 | Elastic.Wordiness | Consider using 'act' instead of 'take action'. |
| explore-analyze/alerting/kibana-alerting-v2/manage-alerts/investigate-respond.md | 13 | Elastic.Wordiness | Consider using 'act' instead of 'take action'. |
| explore-analyze/alerting/kibana-alerting-v2/manage-rules/snooze-disable-rules.md | 2 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/alerting/kibana-alerting-v2/manage-rules/snooze-disable-rules.md | 11 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| explore-analyze/machine-learning/anomaly-detection/ml-configuring-alerts.md | 252 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| manage-data/data-store/data-streams/failure-store-recipes.md | 310 | Elastic.Wordiness | Consider using 'because' instead of 'Since'. |
| manage-data/data-store/data-streams/failure-store-recipes.md | 311 | Elastic.WordChoice | Consider using 'efficient, basic' instead of 'simple', unless the term is in the UI. |
| reference/fleet/monitor-elastic-agent.md | 258 | Elastic.WordChoice | Consider using 'refer to (if it's a document), view (if it's a UI element)' instead of 'see', unless the term is in the UI. |
| solutions/security/detect-and-alert/reduce-noise-and-false-positives.md | 69 | Elastic.Wordiness | Consider using 'all' instead of 'all of '. |
| solutions/security/detect-and-alert/using-logsdb-index-mode-with-elastic-security.md | 66 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/elasticsearch/mapping-explosion.md | 35 | Elastic.WordChoice | Consider using 'can, might' instead of 'may', unless the term is in the UI. |
| troubleshoot/kibana/alerts.md | 38 | Elastic.Wordiness | Consider using 'also' instead of 'In addition'. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
Update internal links to use -v1 suffixed filenames after the alerting directory restructure (create-manage-rules-v1.md, view-alerts-v1.md, alerting-setup-v1.md). Made-with: Cursor
Contributor
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
Fixes https://github.com/elastic/docs-content-internal/issues/919. Adds v2 alerting docs.
Generative AI disclosure
Cursor + Claude