elastic / elastic/opentelemetry

Docs fix — applies_to: shard 1/1 — 27 pages

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

Description

Generated by `gh-aw-docs-applies-to-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 (2)

```yaml
- file: docs/reference/edot-cloud-forwarder/gcp/index.md
line: 11
category: invalid-applies-to-value
severity: medium
evidence: >
applies_to.product.edot_cf_gcp uses a product key not present in the published
quick reference at /docs/contribute-docs/how-to/cumulative-docs/reference.
Documented EDOT Cloud Forwarder product keys are edot_cf_aws and edot_cf_azure only.
edot_cf_gcp may be unrecognised by docs-builder, producing a missing-badge or
silent no-op rather than the intended Technical Preview badge.
suggested_fix: |
# Option A — remove the product stanza until edot_cf_gcp is formally registered
# in the applies_to schema; the deployment dimension already covers ECH/self context.
applies_to:
serverless:
observability: preview
deployment:
ech: preview
self: unavailable

- file: docs/reference/edot-cloud-forwarder/gcp/index.md
line: 4
category: inconsistent-applies-to
severity: medium
evidence: >
The page-level applies_to block mixes two primary dimensions: 'deployment'
(lines 7–9) and 'product' (lines 10–11). The cumulative-docs guidelines state
"Use only one dimension at the page level" (Stack/Serverless, Deployment, or Product).
serverless is permitted alongside deployment but product is a distinct third dimension.
Mixing deployment and product at the page level violates this rule.
suggested_fix: |
# Remove the 'product' stanza from the page-level frontmatter.
# If product-lifecycle context is needed for a specific section, add a
# section-level annotation after the relevant heading instead.
applies_to:
serverless:
observability: preview
deployment:
ech: preview
self: unavailable
```

## Done when
- All listed pages have a valid `applies_to` block per the verified reference.
- A PR addressing this issue is merged.

## Notes
- Snippet files under `docs/reference/_snippets/` are excluded from this sweep; they are included partials, not standalone pages, and do not appear in `toc.yml`.
- Fifteen pages use `stack:` and/or `serverless: observability:` with null lifecycle values (no `ga`, `preview`, etc.). This pattern appears throughout the corpus and is consistent with the `stack: all` shorthand seen in official example scenarios; it is not flagged pending clarification from the docs-builder schema.

> Generated by [Docs `applies_to` sweep agent](https://github.com/elastic/opentelemetry/actions/runs/27820348068) · 593.4 AIC · ⌖ 13.1 AIC · ⊞ 33.4K · [◷](https://github.com/search?q=repo%3Aelastic%2Fopentelemetry+is%3Aissue+%22gh-aw-workflow-call-id%3A+elastic%2Fopentelemetry%2Fgh-aw-docs-applies-to-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.