[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722
Draft
nastasha-solomon wants to merge 7 commits into
Draft
[UIAM API key] Adds docs for Elastic Cloud API keys and rules#6722nastasha-solomon wants to merge 7 commits into
nastasha-solomon wants to merge 7 commits into
Conversation
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
Contributor
Vale Linting ResultsSummary: 2 warnings, 5 suggestions found
|
| File | Line | Rule | Message |
|---|---|---|---|
| solutions/observability/incident-management/create-latency-threshold-rule.md | 17 | Elastic.DontUse | Don't use 'and/or'. |
| solutions/observability/incident-management/create-latency-threshold-rule.md | 17 | Elastic.Latinisms | Latin terms and abbreviations are a common source of confusion. Use 'for example' instead of 'e.g'. |
💡 Suggestions (5)
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/alerting/alerts/alerting-setup.md | 100 | Elastic.WordChoice | Consider using 'deactivate, deselect, hide, turn off' instead of 'disable', unless the term is in the UI. |
| solutions/observability/incident-management/create-an-inventory-rule.md | 49 | Elastic.Semicolons | Use semicolons judiciously. |
| solutions/security/detect-and-alert/detection-rule-concepts.md | 95 | Elastic.WordChoice | Consider using 'run, start' instead of 'Execute', unless the term is in the UI. |
| solutions/security/detect-and-alert/detection-rule-concepts.md | 97 | Elastic.WordChoice | Consider using 'run, start' instead of 'Execute', unless the term is in the UI. |
| solutions/security/detect-and-alert/detection-rule-concepts.md | 123 | Elastic.WordChoice | Consider using 'run, start' instead of 'execute', unless the term is in the UI. |
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.
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
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
Addresses #702 by adding a new reference page for Elastic Cloud API keys and rules, and propagating a Serverless-scoped note across all relevant rule creation and management pages.
Also created a new reusable snippet at
solutions/_snippets/elastic-cloud-api-key-rules.md. The snipped it a Serverless-scoped note that explains new and edited rules automatically use Elastic Cloud API keys, and links to the new reference page. It's been included in the following pages:Stack alerting docs
Observability alerting docs
Secrurity alerting docs
Review request
{{es}} API keywith a link to the Elasticsearch API keys page.