elastic/docs-content

[Chore] Review `docset.yml` for subs that can be removed

Open

#3,536 opened on Oct 17, 2025

View on GitHub
 (7 comments) (3 reactions) (0 assignees) (251 forks)auto 404
Confidence: 1Effort: 0.1Impact: 1Reach: 1chorecross-teamgood first issuegood-for-ai

Repository metrics

Stars
 (46 stars)
PR merge metrics
 (PR metrics pending)

Description

In my opinion, subs aren't as helpful if we don't use them consistently. In https://github.com/elastic/elastic-docs-vscode/pull/2, we added inline warnings when an author hard-codes the value of a sub instead of using the sub key, which provides a light-touch way to encourage consistent use of subs and weed out unnecessary subs without introducing a bunch of errors.

However, there are some subs that are likely unnecessary, like api-examples-title: Examples, that should be removed from docset.yml. We should go through repo-level subs in this repo (and others) and eliminate any unnecessary subs.

cc @theletterf @florent-leborgne

Contributor guide

Research direction
Audit each sub defined in docset.yml and identify those that are either not used or have a single use, as they contribute little value. Check usage across the repository using grep or similar tools. Remove obvious candidates and propose changes in a pull request.
Tech stack
None
Domain
documentation
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitYAML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80