elastic/docs-content

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

Aperta

#3536 aperta il 17 ott 2025

Vedi su GitHub
 (7 commenti) (3 reazioni) (0 assegnatari) (251 fork)auto 404
Confidence: 1Effort: 0.1Impact: 1Reach: 1chorecross-teamgood first issuegood-for-ai

Metriche repository

Star
 (46 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Controlla ogni sub definito in docset.yml e identifica quelli che non vengono utilizzati o hanno un solo uso, poiché contribuiscono poco valore. Verifica l'uso nel repository usando grep o strumenti simili. Rimuovi i candidati ovvi e proponi le modifiche in una pull request.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Manutenzione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitYAML
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80