docs: link mentions of config parameters #5521
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Inspired by #5519 (review), went looking for config parameter references in docs that could use a hash in their link, ended up finding unlinked references instead. This PR links them to
/using-npm/config
.I tried to be thoughtful about which ones I linked and which I skipped. For example, in
docs/content/using-npm/logging.md
, I didn't linklogs-dir
orloglevel
because the information in/using-npm/config
didn't add anything new.I think I avoided making any edits inside "automatically generated" sections.
I initially used this search:
(?<!`workspace)` config[^\]]
... including
*.md
files, and excludingCHANGELOG.md,CHANGELOG-*.md
files.I started out excluding
`workspace` config
because it occurs often in automatically generated sections.I later went back and checked all occurrences of
`workspace` config
, I found one that seemed worth linking.I searched for:
^.{81}
(including
*.md
files, and excludingCHANGELOG.md,CHANGELOG-*.md
files)... to make sure I respected what seem to be the norm (lines wrapped at 80 chars). Seems like there are lots of exceptions, should those be fixed, and should that norm be documented somewhere?
References
Continuation of #5519