elastic / elastic/docs-content

Docs fix — frontmatter: shard 1/1 — 16 pages

Open
#7,000 0 comments 0 reactions 0 assignees View on GitHub
docs-fix:frontmatter docs-quality-sweep
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 21h
Merged PRs (30d)
141

Description

Generated by `gh-aw-docs-frontmatter-sweep` for `elastic/docs-content` on 2026-W25.

Shard 1/1 · 16 pages in slice · 0 recently-changed · 16 total in scope · corpus 16 pages.

## Findings (16)

```yaml
- file: explore-analyze/alerting/alerts/alerting-common-issues.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Troubleshooting guide for common Kibana alerting issues, including rules running late due to small check intervals and inconsistent schedule cadence."

- file: explore-analyze/alerting/alerts/alerting-getting-started.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Kibana alerting is the built-in system for defining rules that detect conditions and trigger notifications across apps via connectors."

- file: explore-analyze/alerting/alerts/alerting-setup.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to set up Kibana alerting, including prerequisites, security settings, and production configuration for scaling rule execution."

- file: explore-analyze/alerting/alerts/alerting-troubleshooting.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Troubleshooting guide for Kibana alerting rules and connectors, including log inspection, debugging tools, and known limitations."

- file: explore-analyze/alerting/alerts/create-manage-rules.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to create and manage Kibana alerting rules from the Stack Management interface, including permissions and rule lifecycle operations."

- file: explore-analyze/alerting/alerts/event-log-index.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Reference for the Kibana alerting event log index, with example queries for monitoring rule and action execution history."

- file: explore-analyze/alerting/alerts/geo-alerting.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to configure a tracking containment rule that alerts when an entity enters or exits a defined geographic boundary."

- file: explore-analyze/alerting/alerts/maintenance-windows.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to create and manage maintenance windows to suppress alerting rule notifications during scheduled downtime periods."

- file: explore-analyze/alerting/alerts/notifications-domain-allowlist.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to configure the notifications domain allowlist to restrict recipient domains for alert emails sent by Kibana alerting and Watcher."

- file: explore-analyze/alerting/alerts/query-alerts.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to query Kibana alert indices when building rules, dashboards, or visualizations, with index names, aliases, and sample queries by rule type."

- file: explore-analyze/alerting/alerts/rule-action-variables.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Reference for Kibana rule action variables available in Mustache templates, including common, alert-specific, and connector-specific variables."

- file: explore-analyze/alerting/alerts/rule-type-es-query.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to configure an Elasticsearch query rule that runs a query, compares matches to a threshold, and triggers actions when the condition is met."

- file: explore-analyze/alerting/alerts/rule-type-index-threshold.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to configure an index threshold rule that aggregates field values from Elasticsearch documents and triggers actions when thresholds are met."

- file: explore-analyze/alerting/alerts/rule-types.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "Reference for Kibana alerting rule types, including stack rules, observability rules, and security rules available across Kibana apps."

- file: explore-analyze/alerting/alerts/testing-connectors.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to test Kibana connectors using the Test tab in the connector edit flyout or the Save & test button after creating a connector."

- file: explore-analyze/alerting/alerts/view-alerts.md
line: 1
category: missing-description
severity: high
evidence: "frontmatter has no `description` field"
suggested_fix: |
description: "How to view, filter, and manage alerts generated by Kibana alerting rules, including alert details, status, and maintenance windows."
```

## Done when
- All listed pages have a non-empty, <=200-character `description` field and required frontmatter keys present per the repo's frontmatter schema.
- A PR addressing this issue is merged.

## Notes
- `rule-type-es-query.md` has `navigation_title: "{{es}} query"` — substitution variables are not parsed in frontmatter, so navigation renders the literal text `{{es}} query` instead of `Elasticsearch query`; consider using plain text (`Elasticsearch query`) there too.

> Generated by [Docs frontmatter sweep agent](https://github.com/elastic/docs-content/actions/runs/27794967027) · 164.4 AIC · ⌖ 41.6 AIC · ⊞ 27K · [◷](https://github.com/search?q=repo%3Aelastic%2Fdocs-content+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fdocs-content%2Fgh-aw-docs-frontmatter-sweep%22&type=issues)

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the 16 listed Markdown files under explore-analyze/alerting/alerts/ and inspect their frontmatter at line 1 alongside the repository's frontmatter schema. Add the specified non-empty descriptions and verify the navigation_title note for rule-type-es-query.md. Done means every listed page has valid required keys and descriptions of 200 characters or fewer, with a merged PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
elasticsearch
Domain
documentation, observability
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.