elastic / elastic/docs-content

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

Open
#3,536 7 comments 3 reactions 0 assignees View on GitHub
chore Confidence: 1 cross-team Effort: 0.1 good first issue good-for-ai Impact: 1 Reach: 1
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 12h
Merged PRs (30d)
116

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

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.