elastic / elastic/opentelemetry

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

Open
#615 0 comments 1 reaction 2 assignees Claimed by @theletterf View on GitHub
docs-fix:frontmatter docs-quality-sweep
Dominant language
Python
Stars
37
Forks
50
Avg merge
23h 31m
Merged PRs (30d)
3

Description

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

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

## Findings (13)

```yaml
- file: docs/reference/central-configuration.md
line: 3
category: weak-description
severity: medium
evidence: "description uses label prefix 'Reference documentation for' — not a value-focused sentence"
suggested_fix: |
description: "Manage EDOT SDK settings remotely through the APM Agent Central Configuration feature, with changes automatically propagated to all deployed SDKs."

- file: docs/reference/compatibility/collectors.md
line: 3
category: weak-description
severity: medium
evidence: "description is a noun phrase fragment ('Compatibility and support information for...')"
suggested_fix: |
description: "The EDOT Collector compatibility matrix covers supported Elastic Stack versions, operating systems, and support levels for each distribution release."

- file: docs/reference/compatibility/edot-vs-upstream.md
line: 3
category: weak-description
severity: medium
evidence: "description starts with 'How' forming a noun clause, not a complete sentence"
suggested_fix: |
description: "Elastic Distributions of OpenTelemetry (EDOT) build on upstream OpenTelemetry components, adding production-ready defaults, Elastic-specific capabilities, and official support."

- file: docs/reference/compatibility/features.md
line: 3
category: weak-description
severity: medium
evidence: "description 'Overview of Elastic features available with EDOT.' is a generic label-prefix fragment"
suggested_fix: |
description: "Elastic Observability features work with EDOT, with varying compatibility and support levels across logs, metrics, traces, and analytics."

- file: docs/reference/compatibility/index.md
line: 3
category: weak-description
severity: medium
evidence: "description is a noun phrase fragment ('Compatibility and support levels for different OpenTelemetry Distributions.')"
suggested_fix: |
description: "EDOT components have specific compatibility and support levels depending on the OpenTelemetry Collector, SDK, and Elastic Stack version combination used."

- file: docs/reference/compatibility/limitations.md
line: 3
category: weak-description
severity: medium
evidence: "description is a noun phrase fragment ('Limitations of Elastic Distributions of OpenTelemetry (EDOT)...')"
suggested_fix: |
description: "EDOT uses OTel-native ingestion, which has known limitations compared to classic Elastic APM agents and integration-based data collection."

- file: docs/reference/compatibility/nomenclature.md
line: 3
category: weak-description
severity: medium
evidence: "description starts with 'Explanation of' forming a noun phrase fragment"
suggested_fix: |
description: "The three compatibility states — Incompatible, Compatible, and Supported — define how EDOT components interoperate with upstream OpenTelemetry tools."

- file: docs/reference/compatibility/sdks.md
line: 3
category: weak-description
severity: medium
evidence: "description is a noun phrase fragment ('Compatibility and support information for EDOT SDK versions...')"
suggested_fix: |
description: "The EDOT SDK compatibility matrix shows supported SDK versions per language and the corresponding EDOT Collector version requirements."

- file: docs/reference/edot-cloud-forwarder/index.md
line: 3
category: weak-description
severity: medium
evidence: "description opens with label prefix 'Introduction to' and uses second-person 'your' (not impersonal)"
suggested_fix: |
description: "EDOT Cloud Forwarder is a serverless-deployed EDOT Collector that collects and forwards telemetry from AWS, GCP, and Azure to Elastic Observability."

- file: docs/reference/edot-sdks/index.md
line: 3
category: weak-description
severity: medium
evidence: "description opens with generic 'An overview of' and is a noun phrase fragment"
suggested_fix: |
description: "EDOT SDKs are production-ready OpenTelemetry language distributions that capture traces, metrics, and logs with minimal configuration and seamless Elastic integration."

- file: docs/reference/index.md
line: 3
category: weak-description
severity: medium
evidence: "description uses label prefix 'Reference documentation for' and is a noun phrase fragment"
suggested_fix: |
description: "Elastic Distributions of OpenTelemetry (EDOT) are open-source OpenTelemetry distributions for the Collector, SDKs, and cloud integrations, tailored for Elastic Observability."

- file: docs/reference/motlp/index.md
line: 3
category: weak-description
severity: medium
evidence: "description uses label prefix 'Reference documentation for' and is a noun phrase fragment"
suggested_fix: |
description: "The Elastic Cloud Managed OTLP Endpoint provides a hosted ingestion layer for sending OpenTelemetry data directly to Elastic Cloud using the OTLP protocol."

- file: docs/reference/motlp/rate-limiting.md
line: 3
category: weak-description
severity: medium
evidence: "description 'Rate limiting for the Elastic Cloud Managed OTLP Endpoint.' is a title-like fragment with no value proposition"
suggested_fix: |
description: "The Elastic Cloud Managed OTLP Endpoint applies rate limiting when ingestion exceeds cluster capacity, responding with HTTP 429 errors until the data volume is reduced."
```

## Done when
- All listed pages have a non-empty, ≤200-character `description` that is a complete sentence, value-focused, impersonal, and free of label prefixes (`Reference documentation for`, `Introduction to`, `Overview of`, `An overview of`).
- A PR addressing this issue is merged.

## Notes
- Six `_snippets/` files in scope contain no frontmatter; they are transclusion fragments (used via `:::{include}`) and do not require frontmatter.

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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.