Loading
chore(docs): enable gitlab_docs Vale styles for docs/source
Description
docs/.vale/gitlab_docs/ is now listed in BasedOnStyles.
Two gitlab_docs rules are switched off for this project:
RelativeLinks:docs/sourceis generated from the Go help text ininternal/commands, and the same strings print in the terminal forglab <command> --help, where a relative Markdown path means nothing. Full URLs todocs.gitlab.comare correct here.InternalLinksCode: The rule's pattern matches links into aconfig/directory, one of the top-level directories ingitlab-org/gitlab. glab has its ownconfigcommands, so every generated link to aconfigsubcommand page is a false positive.
Verification
vale --minAlertLevel error docs, the command check_docs_markdown runs, reports
0 errors across 295 files. Before the two exclusions it reported 20 errors: 17
RelativeLinks and 3 InternalLinksCode. Checked locally with Vale 3.12.0; CI uses
3.18.0.
Related issues and merge requests
Edited by Brendan Lynch