diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6e907a87..ca8c042b 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -63,7 +63,7 @@ check_docs_update: fi check_docs_markdown: - image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.20.1-markdownlint-0.32.2 + image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.18-vale-2.29.6-markdownlint-0.37.0-markdownlint2-0.10.0 extends: .documentation script: # Lint prose diff --git a/.markdownlint.yml b/.markdownlint.yml index 3b8b8e1b..5a9e1f05 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -33,7 +33,6 @@ proper-names: "API", "Asana", "Auth0", - "Authentiq", "Azure", "Bamboo", "Bitbucket", @@ -53,10 +52,12 @@ proper-names: "Geo", "Git LFS", "git-annex", - "git-credential", + "git-credential-oauth", "git-sizer", + "Git", "Gitaly", "GitHub", + "gitlab.vim", "GitLab Geo", "GitLab Monitor", "GitLab Operator", @@ -98,17 +99,18 @@ proper-names: "minikube", "MinIO", "ModSecurity", + "Neovim", "NGINX Ingress", "NGINX", "OAuth", "OAuth 2", "OmniAuth", - "Omnibus GitLab", "OpenID", "OpenShift", "PgBouncer", "Postfix", "PostgreSQL", + "PowerShell", "Praefect", "Prometheus", "Puma", @@ -130,7 +132,6 @@ proper-names: "Slack", "SMTP", "SpotBugs", - "ssh-key", "SSH", "Tiller", "TOML", @@ -150,3 +151,4 @@ proper-names: "YouTrack" ] code_blocks: false + html_elements: false diff --git a/.tool-versions b/.tool-versions index 09548d5e..f3583154 100644 --- a/.tool-versions +++ b/.tool-versions @@ -1 +1,2 @@ golang 1.19.13 +vale 2.29.6 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 50806cb9..c2fcc55a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,7 +199,7 @@ This is a very short description of the change Just as in the description, use imperative, present tense: “change” not “changed” nor “changes.” Include motivation for the change and contrast it with previous behavior. -#### More info on writing good git commit messages +#### More info on writing good Git commit messages - [Writing Git commit messages](http://365git.tumblr.com/post/3308646748/writing-git-commit-messages) - [A Note About Git Commit Messages](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) diff --git a/README.md b/README.md index b5b0578b..4aebcbca 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ Many core commands also have sub-commands. Some examples: ## Documentation -Read the [documentation](https://gitlab.com/gitlab-org/cli/-/tree/main/docs/source) for usage instructions or check out `glab help`. +Read the [documentation](docs/source/index.md) for usage instructions or check out `glab help`. ## Installation @@ -189,8 +189,8 @@ the `GITLAB_HOST` environment variable, like this: - `GITLAB_HOST=gitlab.example.com glab repo clone group/project` - `GITLAB_HOST=gitlab.example.com glab issue list -R group/project` -When inside a git repository `glab` will use that repository's GitLab host by default. For example `glab issue list` -will list all issues of the current directory's git repository. +When inside a Git repository `glab` will use that repository's GitLab host by default. For example `glab issue list` +will list all issues of the current directory's Git repository. ### Configure `glab` to use self-signed certificates for self-managed instances diff --git a/cmd/gen-docs/docs.go b/cmd/gen-docs/docs.go index 2df404b8..04ab2d01 100644 --- a/cmd/gen-docs/docs.go +++ b/cmd/gen-docs/docs.go @@ -137,9 +137,9 @@ func printSubcommands(cmd *cobra.Command, buf *bytes.Buffer) { for _, cmdC := range cmd.Commands() { if cmdC.Name() != "help" { if cmdC.HasAvailableSubCommands() { - subcommands += fmt.Sprintf("- [%s](%s/index.md)\n", cmdC.Name(), cmdC.Name()) + subcommands += fmt.Sprintf("- [`%s`](%s/index.md)\n", cmdC.Name(), cmdC.Name()) } else { - subcommands += fmt.Sprintf("- [%s](%s.md)\n", cmdC.Name(), cmdC.Name()) + subcommands += fmt.Sprintf("- [`%s`](%s.md)\n", cmdC.Name(), cmdC.Name()) } } } diff --git a/commands/completion/completion.go b/commands/completion/completion.go index 5455f176..9ec403e1 100644 --- a/commands/completion/completion.go +++ b/commands/completion/completion.go @@ -21,7 +21,7 @@ func NewCmdCompletion(io *iostreams.IOStreams) *cobra.Command { Use: "completion", Short: "Generate shell completion scripts", Long: heredoc.Docf(` - The output of this command will be computer code and is meant to be saved + The output of this command will be computer code and is meant to be saved to a file or immediately evaluated by an interactive shell. To load completions: ### Bash @@ -102,10 +102,10 @@ func NewCmdCompletion(io *iostreams.IOStreams) *cobra.Command { %[2]s To load completions for every new session, add the output of the above command - to your powershell profile. + to your PowerShell profile. When installing glab through a package manager, however, it's possible that - no additional shell configuration is necessary to gain completion support. + no additional shell configuration is necessary to gain completion support. For Homebrew, see `, "`", "```"), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/docs/.vale/gitlab/Admin.yml b/docs/.vale/gitlab/Admin.yml deleted file mode 100644 index 78a86e27..00000000 --- a/docs/.vale/gitlab/Admin.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Suggestion: gitlab.Admin -# -# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: substitution -message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html -level: suggestion -ignorecase: false -swap: - '[Aa]dmin ?\w*': '(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative|ering|ered))' diff --git a/docs/.vale/gitlab/AlertBoxStyle.yml b/docs/.vale/gitlab/AlertBoxStyle.yml index 5912c470..0a4514fa 100644 --- a/docs/.vale/gitlab/AlertBoxStyle.yml +++ b/docs/.vale/gitlab/AlertBoxStyle.yml @@ -3,13 +3,13 @@ # # Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues: # -# - Alert boxes inside a block quote (">") +# - Alert boxes inside a block quote ('>') # - Alert boxes with the note text on the same line -# - Alert boxes using words other than "NOTE" or "WARNING" +# - Alert boxes using words other than 'NOTE' or 'WARNING' # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Alert box "%s" must use the formatting in the style guide.' +message: "Update the format of the '%s' alert box. View the style guide for details." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes level: error nonword: true diff --git a/docs/.vale/gitlab/BadPlurals.yml b/docs/.vale/gitlab/BadPlurals.yml index 533805c6..9cdb8661 100644 --- a/docs/.vale/gitlab/BadPlurals.yml +++ b/docs/.vale/gitlab/BadPlurals.yml @@ -1,11 +1,11 @@ --- # Warning: gitlab.BadPlurals # -# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable. +# Don't write plural words with the '(s)' construction. 'HTTP(S)' is acceptable. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rewrite "%s" to be plural, without parentheses.' +message: "Rewrite '%s' to be plural without parentheses." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#s level: warning ignorecase: true diff --git a/docs/.vale/gitlab/BadgeCapitalization.yml b/docs/.vale/gitlab/BadgeCapitalization.yml index 33425693..a44bcbc0 100644 --- a/docs/.vale/gitlab/BadgeCapitalization.yml +++ b/docs/.vale/gitlab/BadgeCapitalization.yml @@ -3,12 +3,12 @@ # # Verifies that badges are not mixed case, which won't render properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Badge "%s" must be capitalized.' +message: "Capitalize the '%s' badge." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges level: error scope: raw raw: - - '(?!\*\*\((FREE|PREMIUM|ULTIMATE)( (SELF|SAAS))?\)\*\*)' - - '(?i)\*\*\((free|premium|ultimate)( (self|saas))?\)\*\*' + - '(?!\*\*\((FREE|PREMIUM|ULTIMATE)( (SELF|SAAS|ALL) (BETA|EXPERIMENT))?\)\*\*)' + - '(?i)\*\*\((free|premium|ultimate)( (self|saas|all) (beta|experiment))?\)\*\*' diff --git a/docs/.vale/gitlab/British.yml b/docs/.vale/gitlab/British.yml index c63cbd91..432ed302 100644 --- a/docs/.vale/gitlab/British.yml +++ b/docs/.vale/gitlab/British.yml @@ -3,9 +3,9 @@ # # Checks that US spelling is used instead of British spelling. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use the US spelling "%s" instead of the British "%s".' +message: "Use the US spelling '%s' instead of the British '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: error ignorecase: true diff --git a/docs/.vale/gitlab/CIConfigFile.yml b/docs/.vale/gitlab/CIConfigFile.yml index 5a65e51e..5cbd02e7 100644 --- a/docs/.vale/gitlab/CIConfigFile.yml +++ b/docs/.vale/gitlab/CIConfigFile.yml @@ -3,15 +3,11 @@ # # Checks that the `.gitlab-ci.yml` file is referenced properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The CI/CD configuration file should be exactly: `.gitlab-ci.yml`' +message: "Change the file name to be exactly '.gitlab-ci.yml'." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw raw: - - '(`gitlab-ci.yml`|' - - '`gitlabci.yml`|' - - '`gitlab.ci.yml`|' - - '`.gitlab.ci-yml`|' - - '`.gitlab-ci.yaml`)' + - '(?!`\.gitlab-ci\.yml`)`.?gitlab.?ci.?ya?ml`' diff --git a/docs/.vale/gitlab/CodeblockFences.yml b/docs/.vale/gitlab/CodeblockFences.yml index 6c2d94e7..27159f7e 100644 --- a/docs/.vale/gitlab/CodeblockFences.yml +++ b/docs/.vale/gitlab/CodeblockFences.yml @@ -3,11 +3,11 @@ # # Ensures all codeblock language tags use the full name, not aliases. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.' +message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, go, python, dockerfile, or typescript." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks level: error scope: raw raw: - - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)' + - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|golang\n|py\n|docker\n|ts)' diff --git a/docs/.vale/gitlab/CommandStringsQuoted.yml b/docs/.vale/gitlab/CommandStringsQuoted.yml new file mode 100644 index 00000000..531595ed --- /dev/null +++ b/docs/.vale/gitlab/CommandStringsQuoted.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.CommandStringsQuoted +# +# Ensures all code blocks wrap URL strings in quotation marks. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "For the command example, use double quotes around the URL: %s" +link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands +level: error +scope: raw +nonword: true +tokens: + - '(curl|--url)[^"\]\n]+?https?:\/\/[^ \n]*' diff --git a/docs/.vale/gitlab/CurlStringsQuoted.yml b/docs/.vale/gitlab/CurlStringsQuoted.yml deleted file mode 100644 index a59fe64d..00000000 --- a/docs/.vale/gitlab/CurlStringsQuoted.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Error: gitlab.CurlStringsQuoted -# -# Ensures all code blocks using `curl` wrap URL strings in quotation marks. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: existence -message: 'For consistency across all cURL examples, always wrap the URL in double quotes ("): %s' -link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands -level: error -scope: code -raw: - - 'curl [^"]+://.*' diff --git a/docs/.vale/gitlab/CurrentStatus.yml b/docs/.vale/gitlab/CurrentStatus.yml index 040fd3d8..9972573b 100644 --- a/docs/.vale/gitlab/CurrentStatus.yml +++ b/docs/.vale/gitlab/CurrentStatus.yml @@ -1,14 +1,13 @@ --- -# Suggestion: gitlab.CurrentStatus +# Warning: gitlab.CurrentStatus # # Checks for words that indicate a product or feature may change in the future. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid words like "%s" when you write about future features. Our documentation is about the current state of the product.' -level: suggestion +message: "Remove '%s'. The documentation reflects the current state of the product." +level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#promising-features-in-future-versions +link: https://docs.gitlab.com/ee/development/documentation/versions.html#promising-features-in-future-versions tokens: - currently - - yet diff --git a/docs/.vale/gitlab/DefaultBranch.yml b/docs/.vale/gitlab/DefaultBranch.yml index 4bc68433..86c627bc 100644 --- a/docs/.vale/gitlab/DefaultBranch.yml +++ b/docs/.vale/gitlab/DefaultBranch.yml @@ -1,14 +1,14 @@ --- # Warning: gitlab.DefaultBranch # -# Do not refer to the default branch as the "master" branch, if possible. +# Do not refer to the default branch as the 'master' branch, if possible. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "default branch" or `main` instead of `master`, when possible.' +message: "Use 'default branch' or `main` instead of `master`, when possible." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#default-branch scope: raw raw: - '\`master\`' diff --git a/docs/.vale/gitlab/Dropdown.yml b/docs/.vale/gitlab/Dropdown.yml index 691d44d1..c656d120 100644 --- a/docs/.vale/gitlab/Dropdown.yml +++ b/docs/.vale/gitlab/Dropdown.yml @@ -3,11 +3,11 @@ # # Catches many ways the phrase 'dropdown list' can be fumbled. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "dropdown list".' +message: "Use 'dropdown list'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#dropdown-list -level: suggestion +level: warning ignorecase: true tokens: - drop-down( [\w]*)? diff --git a/docs/.vale/gitlab/EOLWhitespace.yml b/docs/.vale/gitlab/EOLWhitespace.yml index e160b706..15378644 100644 --- a/docs/.vale/gitlab/EOLWhitespace.yml +++ b/docs/.vale/gitlab/EOLWhitespace.yml @@ -3,9 +3,9 @@ # # Checks that there is no useless whitespace at the end of lines. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Lines should not end with whitespace characters.' +message: "Remove whitespace characters from the end of the line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: warning scope: raw diff --git a/docs/.vale/gitlab/ElementDescriptors.yml b/docs/.vale/gitlab/ElementDescriptors.yml index 36f1202a..fd3acace 100644 --- a/docs/.vale/gitlab/ElementDescriptors.yml +++ b/docs/.vale/gitlab/ElementDescriptors.yml @@ -1,13 +1,14 @@ --- -# Suggestion: gitlab.ElementDescriptors +# Warning: gitlab.ElementDescriptors # -# Suggests the correct way to describe elements in a form. +# Suggests the correct way to describe a button. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ -extends: substitution -message: 'When describing elements, %s "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language -level: suggestion +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "If possible, rewrite to remove 'button'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#button +level: warning ignorecase: true -swap: - button: 'if possible, rewrite to remove' +scope: raw +raw: + - \*\*[^*]+\*\*\s+button diff --git a/docs/.vale/gitlab/FirstPerson.yml b/docs/.vale/gitlab/FirstPerson.yml deleted file mode 100644 index 6fc93d95..00000000 --- a/docs/.vale/gitlab/FirstPerson.yml +++ /dev/null @@ -1,16 +0,0 @@ ---- -# Warning: gitlab.FirstPerson -# -# Checks for use of first person pronouns. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: existence -message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.' -level: warning -ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list -tokens: - - '\bI[ ,;:?!"]|\bI\x27.{1,2}' - - me - - myself - - mine diff --git a/docs/.vale/gitlab/FutureTense.yml b/docs/.vale/gitlab/FutureTense.yml index 64e79612..d1484b20 100644 --- a/docs/.vale/gitlab/FutureTense.yml +++ b/docs/.vale/gitlab/FutureTense.yml @@ -3,12 +3,12 @@ # # Checks for use of future tense in sentences. Present tense is strongly preferred. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid using future tense: "%s". Use present tense instead.' +message: "Instead of future tense '%s', use present tense." ignorecase: true level: warning -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#future-tense raw: - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" - "will( |\n|[[:punct:]])[a-zA-Z]*|" diff --git a/docs/.vale/gitlab/GitLabFlavoredMarkdown.yml b/docs/.vale/gitlab/GitLabFlavoredMarkdown.yml new file mode 100644 index 00000000..532f1afd --- /dev/null +++ b/docs/.vale/gitlab/GitLabFlavoredMarkdown.yml @@ -0,0 +1,14 @@ +--- +# Warning: gitlab.GitLabFlavoredMarkdown +# +# Checks for unclear use of GLFM or GLM instead of GitLab/GitHub Flavored Markdown +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: substitution +message: "Use '%s' instead of '%s' when possible." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: warning +ignorecase: true +swap: + GLFM: "GitLab Flavored Markdown" + GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown" diff --git a/docs/.vale/gitlab/HeadingContent.yml b/docs/.vale/gitlab/HeadingContent.yml index c2dd2a5c..ef130aa8 100644 --- a/docs/.vale/gitlab/HeadingContent.yml +++ b/docs/.vale/gitlab/HeadingContent.yml @@ -3,16 +3,17 @@ # # Checks for generic, unhelpful subheadings. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rename the subheading "%s", or re-purpose the content elsewhere.' +message: "Rename the heading '%s', or re-purpose the content elsewhere." level: warning -scope: heading -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#headings-1 -ignorecase: false +link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-headings +ignorecase: true +nonword: true +scope: raw tokens: - - How it works - - Limitations - - Overview - - Use cases? - - Important notes? + - '\#+ How it works' + - '\#+ Limitations' + - '\#+ Overview' + - '\#+ Use cases?' + - '\#+ Important notes?' diff --git a/docs/.vale/gitlab/HeadingDepth.yml b/docs/.vale/gitlab/HeadingDepth.yml index 466ab317..000baf63 100644 --- a/docs/.vale/gitlab/HeadingDepth.yml +++ b/docs/.vale/gitlab/HeadingDepth.yml @@ -1,13 +1,13 @@ --- -# Warning: gitlab.HeadingDepth +# Suggestion: gitlab.HeadingDepth # # Checks that there are no headings greater than 3 levels # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The subheading "%s" is nested too deeply. Headings deeper than H5 suggest the section or page should be refactored.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#headings-in-markdown -level: warning +message: "Refactor the section or page to avoid headings greater than H5." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown +level: suggestion scope: raw raw: - - '(?<=\n)#{5,}\s.*' + - '(?<=\n)#{6,}\s.*' diff --git a/docs/.vale/gitlab/InclusionAbleism.yml b/docs/.vale/gitlab/InclusionAbleism.yml index 1ebb6a97..3ee35615 100644 --- a/docs/.vale/gitlab/InclusionAbleism.yml +++ b/docs/.vale/gitlab/InclusionAbleism.yml @@ -1,13 +1,13 @@ --- -# Suggestion: gitlab.InclusionAbleism +# Warning: gitlab.InclusionAbleism # # Suggests alternatives for words that foster ableism. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language -level: suggestion +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: warning ignorecase: true swap: sanity (?:check|test): check for completeness diff --git a/docs/.vale/gitlab/InclusionCultural.yml b/docs/.vale/gitlab/InclusionCultural.yml index 6f63d172..6de838e7 100644 --- a/docs/.vale/gitlab/InclusionCultural.yml +++ b/docs/.vale/gitlab/InclusionCultural.yml @@ -3,10 +3,10 @@ # # Suggests alternatives for words that are culturally inappropriate. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning ignorecase: true swap: diff --git a/docs/.vale/gitlab/InclusionGender.yml b/docs/.vale/gitlab/InclusionGender.yml index 313a1cc4..dcf8c193 100644 --- a/docs/.vale/gitlab/InclusionGender.yml +++ b/docs/.vale/gitlab/InclusionGender.yml @@ -1,13 +1,13 @@ --- -# Suggestion: gitlab.InclusionGender +# Warning: gitlab.InclusionGender # # Suggests alternatives for words that are gender-specific. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language -level: suggestion +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: warning ignorecase: true swap: mankind: humanity, people diff --git a/docs/.vale/gitlab/InternalLinkCase.yml b/docs/.vale/gitlab/InternalLinkCase.yml index c00e6334..fded7358 100644 --- a/docs/.vale/gitlab/InternalLinkCase.yml +++ b/docs/.vale/gitlab/InternalLinkCase.yml @@ -3,10 +3,10 @@ # # Checks that anchor fragments on internal links are in lower-case. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Links to subheadings in GitLab docs must be in lower-case: "%s"' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Use lowercase for the anchor link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links level: error scope: raw raw: diff --git a/docs/.vale/gitlab/InternalLinkExtension.yml b/docs/.vale/gitlab/InternalLinkExtension.yml index 52142b50..364263f9 100644 --- a/docs/.vale/gitlab/InternalLinkExtension.yml +++ b/docs/.vale/gitlab/InternalLinkExtension.yml @@ -3,10 +3,10 @@ # # Checks that internal links have .md extenstion and not .html extension. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must link directly to a file and use the .md file extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Link to a file and use the .md file extension instead of .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/docs/.vale/gitlab/InternalLinkFormat.yml b/docs/.vale/gitlab/InternalLinkFormat.yml index b9ee83b7..be09a020 100644 --- a/docs/.vale/gitlab/InternalLinkFormat.yml +++ b/docs/.vale/gitlab/InternalLinkFormat.yml @@ -1,13 +1,13 @@ --- # Error: gitlab.InternalLinkFormat # -# Checks that internal link paths don't start with "./", which is not needed. +# Checks that internal link paths don't start with './', which is not needed. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must not start with "./".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Edit the link so it does not start with './'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: - - '\[.+\]\(\.\/.*?\)' + - '\[[^\]]+\]\(\.\/.*?\)' diff --git a/docs/.vale/gitlab/LatinTerms.yml b/docs/.vale/gitlab/LatinTerms.yml index 12553a80..0f098979 100644 --- a/docs/.vale/gitlab/LatinTerms.yml +++ b/docs/.vale/gitlab/LatinTerms.yml @@ -3,10 +3,10 @@ # # Checks for use of Latin terms. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s", but consider rewriting the sentence.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +message: "Use '%s' instead of '%s', but consider rewriting the sentence." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning nonword: true ignorecase: true @@ -15,3 +15,4 @@ swap: e\. g\.: for example i\.e\.: that is i\. e\.: that is + via: "Use 'with', 'through', or 'by using' instead." diff --git a/docs/.vale/gitlab/Markdown_emoji.yml b/docs/.vale/gitlab/Markdown_emoji.yml deleted file mode 100644 index ac0dab2d..00000000 --- a/docs/.vale/gitlab/Markdown_emoji.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Warning: gitlab.Markdown_emoji -# -# Check for use of GLFM emoji syntax (https://docs.gitlab.com/ee/user/markdown.html#emojis), which doesn't render correctly in documentation. -# -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles -extends: existence -message: 'This appears to be GLFM emoji syntax. Replace "%s" with GitLab SVGs or Unicode emojis.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#gitlab-svg-icons -level: warning -scope: text -raw: - - '(?:\s+|^):[a-zA-Z0-9\-_\+]+:(?:\s+|$|\.)' diff --git a/docs/.vale/gitlab/MeaningfulLinkWords.yml b/docs/.vale/gitlab/MeaningfulLinkWords.yml index 4a255e5a..a0b3bf9c 100644 --- a/docs/.vale/gitlab/MeaningfulLinkWords.yml +++ b/docs/.vale/gitlab/MeaningfulLinkWords.yml @@ -3,13 +3,14 @@ # # Checks for the presence of semantically unhelpful words in link text. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Improve SEO and accessibility by rewriting "%s" in the link text.' +message: "Improve SEO and accessibility by rewriting the link text for '%s'." level: warning -scope: link ignorecase: true -link: https://about.gitlab.com/handbook/communication/#writing-style-guidelines +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links +scope: raw +nonword: true tokens: - - here - - this page + - \[here\]\(.*\) + - \[this page\]\(.*\) diff --git a/docs/.vale/gitlab/MergeConflictMarkers.yml b/docs/.vale/gitlab/MergeConflictMarkers.yml index 4f216ac3..54e044f1 100644 --- a/docs/.vale/gitlab/MergeConflictMarkers.yml +++ b/docs/.vale/gitlab/MergeConflictMarkers.yml @@ -3,9 +3,9 @@ # # Checks for the presence of merge conflict markers. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Merge conflict marker "%s" found.' +message: "Remove the merge conflict marker '%s'." link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request level: error scope: raw diff --git a/docs/.vale/gitlab/MultiLineLinks.yml b/docs/.vale/gitlab/MultiLineLinks.yml index 64ad017f..32fe3827 100644 --- a/docs/.vale/gitlab/MultiLineLinks.yml +++ b/docs/.vale/gitlab/MultiLineLinks.yml @@ -3,10 +3,10 @@ # # Checks that links are all on a single line. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be on a single line, even if very long.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put the full link on one line, even if the link is very long." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/docs/.vale/gitlab/NonStandardQuotes.yml b/docs/.vale/gitlab/NonStandardQuotes.yml index f31d615e..6161a4cc 100644 --- a/docs/.vale/gitlab/NonStandardQuotes.yml +++ b/docs/.vale/gitlab/NonStandardQuotes.yml @@ -3,12 +3,12 @@ # # Use only standard single and double quotes, not left or right quotes. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' +message: "Use standard single quotes or double quotes only. Do not use left or right quotes." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation scope: raw raw: - '[‘’“”]' diff --git a/docs/.vale/gitlab/Normal.yml b/docs/.vale/gitlab/Normal.yml new file mode 100644 index 00000000..0ced9f33 --- /dev/null +++ b/docs/.vale/gitlab/Normal.yml @@ -0,0 +1,14 @@ +--- +# Warning: gitlab.Normal +# +# Suggests alternatives for 'normal'. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: warning +ignorecase: true +swap: + normally: "usually' or 'typically" + normal: "typical' or 'standard" diff --git a/docs/.vale/gitlab/OutdatedVersions.yml b/docs/.vale/gitlab/OutdatedVersions.yml index f25de44a..e55c3063 100644 --- a/docs/.vale/gitlab/OutdatedVersions.yml +++ b/docs/.vale/gitlab/OutdatedVersions.yml @@ -3,10 +3,10 @@ # # Checks for references to versions of GitLab that are no longer supported. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Can this reference to "%s" be refactored?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions +message: "If possible, remove the reference to '%s'." +link: https://docs.gitlab.com/ee/development/documentation/versions.html level: suggestion nonword: true ignorecase: true @@ -22,3 +22,4 @@ tokens: - "GitLab (v)?10." - "GitLab (v)?11." - "GitLab (v)?12." + - "GitLab (v)?13." diff --git a/docs/.vale/gitlab/OxfordComma.yml b/docs/.vale/gitlab/OxfordComma.yml index 1716145b..81a9ae5c 100644 --- a/docs/.vale/gitlab/OxfordComma.yml +++ b/docs/.vale/gitlab/OxfordComma.yml @@ -3,9 +3,9 @@ # # Checks for the lack of an Oxford comma. In some cases, will catch overly complex sentence structures with lots of commas. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use a comma before the last "and" or "or" in a list of four or more items.' +message: "Use a comma before the last 'and' or 'or' in a list of four or more items." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: warning raw: diff --git a/docs/.vale/gitlab/Possessive.yml b/docs/.vale/gitlab/Possessive.yml index 92ae6654..64c9481a 100644 --- a/docs/.vale/gitlab/Possessive.yml +++ b/docs/.vale/gitlab/Possessive.yml @@ -3,11 +3,11 @@ # # The word GitLab should not be used in the possessive form. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "Rewrite '%s' to not use 's." +message: "Remove 's from %s." level: error ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab tokens: - GitLab's diff --git a/docs/.vale/gitlab/Prerequisites.yml b/docs/.vale/gitlab/Prerequisites.yml new file mode 100644 index 00000000..239f9277 --- /dev/null +++ b/docs/.vale/gitlab/Prerequisites.yml @@ -0,0 +1,14 @@ +--- +# Error: gitlab.Prerequisites +# +# The "Prerequisites:" line should always be plural. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Pluralize 'Prerequisites', even if it includes only one item." +link: https://docs.gitlab.com/ee/development/documentation/topic_types/task.html#task-prerequisites +level: warning +nonword: true +scope: text +raw: + - '^Prerequisite:' diff --git a/docs/.vale/gitlab/ReadingLevel.yml b/docs/.vale/gitlab/ReadingLevel.yml index cd7597ee..a1ddebec 100644 --- a/docs/.vale/gitlab/ReadingLevel.yml +++ b/docs/.vale/gitlab/ReadingLevel.yml @@ -4,8 +4,10 @@ # Checks the Flesch-Kincaid reading level. # # https://docs.errata.ai/vale/styles#metric +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: metric -message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." +message: "The grade level is %s. Aim for 8th grade or lower by using shorter sentences and words." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score level: suggestion formula: | diff --git a/docs/.vale/gitlab/ReferenceLinks.yml b/docs/.vale/gitlab/ReferenceLinks.yml index ca994884..d9f20fa1 100644 --- a/docs/.vale/gitlab/ReferenceLinks.yml +++ b/docs/.vale/gitlab/ReferenceLinks.yml @@ -3,10 +3,10 @@ # # Checks for reference-style links that should be converted to inline links. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be inline.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put this link inline with the rest of the text." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/docs/.vale/gitlab/RelativeLinks.yml b/docs/.vale/gitlab/RelativeLinks.yml index 01e30f60..dea7bb09 100644 --- a/docs/.vale/gitlab/RelativeLinks.yml +++ b/docs/.vale/gitlab/RelativeLinks.yml @@ -3,11 +3,11 @@ # # Checks for the presence of absolute hyperlinks that should be relative. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be a relative link with a .md extension.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation -level: warning +message: "Use a relative link instead of a URL, and ensure the file name ends in .md and not .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links +level: error scope: raw raw: - - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/[ce]e.*\)' + - '\[[^\]]+\]\(https://gitlab.com/gitlab-org/cli/-/tree/main/docs.*\)' diff --git a/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml index ce6ce8b5..6a94c7f9 100644 --- a/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml +++ b/docs/.vale/gitlab/RelativeLinksDoubleSlashes.yml @@ -3,10 +3,10 @@ # # Checks for the presence of double slashes in relative URLs. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Relative links must not include a double slash.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation +message: "Remove the double slash from this relative link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/docs/.vale/gitlab/Repetition.yml b/docs/.vale/gitlab/Repetition.yml index c4b0cc14..cdeb29e7 100644 --- a/docs/.vale/gitlab/Repetition.yml +++ b/docs/.vale/gitlab/Repetition.yml @@ -3,9 +3,9 @@ # # Checks for duplicate words, like `the the` or `and and`. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: repetition -message: '"%s" is repeated.' +message: "Remove this duplicate word: '%s'." level: error alpha: true tokens: diff --git a/docs/.vale/gitlab/SentenceLength.yml b/docs/.vale/gitlab/SentenceLength.yml index c60df180..48ebf02b 100644 --- a/docs/.vale/gitlab/SentenceLength.yml +++ b/docs/.vale/gitlab/SentenceLength.yml @@ -1,13 +1,13 @@ --- -# Warning: gitlab.SentenceLength +# Suggestion: gitlab.SentenceLength # # Counts words in a sentence and alerts if a sentence exceeds 25 words. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: occurrence -message: 'Shorter sentences improve readability (max 25 words).' +message: "Improve readability by using fewer than 25 words in this sentence." scope: sentence link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language -level: warning +level: suggestion max: 25 token: \b(\w+)\b diff --git a/docs/.vale/gitlab/SentenceSpacing.yml b/docs/.vale/gitlab/SentenceSpacing.yml index 0288abe8..9ca685b0 100644 --- a/docs/.vale/gitlab/SentenceSpacing.yml +++ b/docs/.vale/gitlab/SentenceSpacing.yml @@ -3,9 +3,9 @@ # # Checks for incorrect spacing (no spaces, or more than one space) around punctuation. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: '"%s" must contain one and only one space.' +message: "Remove the extra space: '%s'" link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: error nonword: true diff --git a/docs/.vale/gitlab/Simplicity.yml b/docs/.vale/gitlab/Simplicity.yml index 44e78f89..fd9b1c5e 100644 --- a/docs/.vale/gitlab/Simplicity.yml +++ b/docs/.vale/gitlab/Simplicity.yml @@ -1,14 +1,14 @@ --- -# Suggestion: gitlab.Simplicity +# Warning: gitlab.Simplicity # # Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.' -level: suggestion +message: "Remove '%s'. Be precise instead of subjective." +level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html tokens: - easy - easily diff --git a/docs/.vale/gitlab/Spelling.yml b/docs/.vale/gitlab/Spelling.yml index 4ebaf7bf..74d91983 100644 --- a/docs/.vale/gitlab/Spelling.yml +++ b/docs/.vale/gitlab/Spelling.yml @@ -8,9 +8,9 @@ # Commands, like `git clone` must use backticks, and must not be added to the # exceptions. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: spelling -message: 'Spelling check: "%s"?' +message: "Check the spelling of '%s'. If the spelling is correct, ask a Technical Writer to add this word to the spelling exception list." level: warning ignore: - gitlab/spelling-exceptions.txt diff --git a/docs/.vale/gitlab/SubstitutionSuggestions.yml b/docs/.vale/gitlab/SubstitutionSuggestions.yml deleted file mode 100644 index 4b77def0..00000000 --- a/docs/.vale/gitlab/SubstitutionSuggestions.yml +++ /dev/null @@ -1,28 +0,0 @@ ---- -# Suggestion: gitlab.SubstitutionSuggestions -# -# Suggests better options for frequently misused terms that are often - but not always - incorrect. -# SubstitutionWarning.yml and Substitutions.yml also exist. -# -# For a list of all options, see https://errata-ai.github.io/vale/styles/ -extends: substitution -message: 'Consider %s instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html -level: suggestion -ignorecase: true -swap: - active user: '"billable user"' - active users: '"billable users"' - docs: '"documentation"' - e-mail: '"email"' - GLFM: '"GitLab Flavored Markdown"' - it is recommended: '"we recommend"' - navigate: go - OAuth2: '"OAuth 2.0"' - once that: '"after that"' - once the: '"after the"' - once you: '"after you"' - since: '"because" or "after"' - sub-group: '"subgroup"' - sub-groups: '"subgroups"' - within: '"in"' diff --git a/docs/.vale/gitlab/SubstitutionWarning.yml b/docs/.vale/gitlab/SubstitutionWarning.yml index d17015b9..07f0f9d6 100644 --- a/docs/.vale/gitlab/SubstitutionWarning.yml +++ b/docs/.vale/gitlab/SubstitutionWarning.yml @@ -1,29 +1,66 @@ --- # Warning: gitlab.SubstitutionWarning # -# Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors. -# Substitutions.yml and SubstitionSuggestions.yml also exist. +# Checks for misused terms or common shorthand that should not be used at GitLab, but can't be flagged as errors. +# Substitutions.yml also exists. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'If possible, use "%s" instead of "%s".' -link: https://about.gitlab.com/handbook/communication/#top-misused-terms +message: "Use '%s' instead of '%s' when possible." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning ignorecase: true swap: - air(?:-| )?gapped: offline environment - bullet: list item - click: select - code base: codebase - config: configuration - deselect: clear - deselected: cleared - distro: distribution - file name: filename - filesystem: file system - GFM: GLFM - info: information - n/a: not applicable - repo: repository - timezone: time zone - utilize: use + active user: "billable user" + active users: "billable users" + air(?:-| )?gapped: "offline environment" + bullet: "list item" + click: "select" + code base: "codebase" + config: "configuration" + confirmation box: "confirmation dialog" + confirmation dialog box: "confirmation dialog" + deselect: "clear" + deselected: "cleared" + dialog box: "dialog" + distro: "distribution" + docs: "documentation" + e-mail: "email" + emojis: "emoji" + ex: "for example" + file name: "filename" + filesystem: "file system" + info: "information" + installation from source: self-compiled installation + installations from source: self-compiled installations + it is recommended: "you should" + logged in user: "authenticated user" + logged-in user: "authenticated user" + modal dialog: "dialog" + modal window: "dialog" + modal: "dialog" + n/a: "not applicable" + navigate to: "go to" + OAuth2: "OAuth 2.0" + omnibus gitlab: "Linux package" + 'omnibus(?!\))': "Linux package" + once that: "after that" + once the: "after the" + once you: "after you" + pack file: packfile + pack files: packfiles + pop-up window: "dialog" + pop-up: "dialog" + popup: "dialog" + repo: "repository" + signed in user: "authenticated user" + signed-in user: "authenticated user" + since: "because' or 'after" + source (?:install|installation): self-compiled installation + source (?:installs|installations): self-compiled installations + sub-group: "subgroup" + sub-groups: "subgroups" + timezone: "time zone" + utiliz(?:es?|ing): "use" + we recommend: "you should" + within: "in" diff --git a/docs/.vale/gitlab/Substitutions.yml b/docs/.vale/gitlab/Substitutions.yml index af426fa7..0d49ac58 100644 --- a/docs/.vale/gitlab/Substitutions.yml +++ b/docs/.vale/gitlab/Substitutions.yml @@ -2,11 +2,11 @@ # Error: gitlab.Substitutions # # Checks for misused terms that should never be used at GitLab. -# SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. +# SubstitutionWarning.yml also exists. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s".' +message: "Use '%s' instead of '%s'." link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true @@ -14,15 +14,17 @@ swap: codequality: code quality Customer [Pp]ortal: Customers Portal disallow: prevent + '(? Introduced in GitLab 14.0. # - `> Removed in GitLab 15.0. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.' +message: "Start each entry with `> -`. Keep long entries on one line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw diff --git a/docs/.vale/gitlab/VersionTextSingleLine.yml b/docs/.vale/gitlab/VersionTextSingleLine.yml index f76574bc..552ccb99 100644 --- a/docs/.vale/gitlab/VersionTextSingleLine.yml +++ b/docs/.vale/gitlab/VersionTextSingleLine.yml @@ -3,9 +3,9 @@ # # Verifies that single-item version notes don't have a hyphen. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Version text with only a single item must not start with a hyphen.' +message: "Do not use a hyphen '-' in version text if there is only a single item." link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item level: error scope: raw diff --git a/docs/.vale/gitlab/Wordy.yml b/docs/.vale/gitlab/Wordy.yml index 7888d16d..9c472f66 100644 --- a/docs/.vale/gitlab/Wordy.yml +++ b/docs/.vale/gitlab/Wordy.yml @@ -3,15 +3,17 @@ # # Suggests shorter versions of wordy phrases. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: '%s "%s".' +message: "%s" link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: - in order to: "Be concise: use 'to' rather than" - needs? to: "Rewrite the sentence, or use 'must', instead of" - note that: "Be concise: rewrite the sentence to not use" - please: "Remove this word from the sentence: " - respectively: "Rewrite the sentence to be more precise, instead of using " + a number of: "Specify the number or remove the phrase." + as well as: "Use 'and' instead of 'as well as'." + note that: "Remove the phrase 'note that'." + please: "Use 'please' only if we've inconvenienced the user." + respectively: "Remove 'respectively' and list each option instead." + and so on: "Remove 'and so on'. Try to use 'like' and provide examples instead." + in order to: "Remove 'in order' and leave 'to'." diff --git a/docs/.vale/gitlab/Zip.yml b/docs/.vale/gitlab/Zip.yml new file mode 100644 index 00000000..69ff980b --- /dev/null +++ b/docs/.vale/gitlab/Zip.yml @@ -0,0 +1,15 @@ +--- +# Warning: gitlab.Zip +# +# Recommends all instances of something.zip be wrapped in backticks +# due to the .zip top-level domain +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: existence +message: "Wrap '%s' in backticks to prevent unintentional links to .zip domain names." +link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/index.md#backticks-in-markdown' +nonword: true +level: error +ignorecase: true +tokens: + - '\b\w*\.zip' diff --git a/docs/.vale/gitlab/spelling-exceptions.txt b/docs/.vale/gitlab/spelling-exceptions.txt index 5d268fdb..575dc713 100644 --- a/docs/.vale/gitlab/spelling-exceptions.txt +++ b/docs/.vale/gitlab/spelling-exceptions.txt @@ -1,36 +1,53 @@ accessor accessors +ACLs +Adafruit +Airbnb +Airtable Akismet Alertmanager Algolia Alibaba +aliuid Aliyun allowlist allowlisted allowlisting allowlists AlmaLinux +AMIs anonymization anonymized Ansible Anthos -Apdex +Anycast +apdex +API +APIs Apparmor +Appetize approvers +Appsec architected architecting archiver Arel arity +Arkose +armhf +ARNs Artifactory Asana Asciidoctor asdf Assembla +Astro +async Atlassian auditability +auditable Auth0 -Authentiq +authenticator Authy autocomplete autocompleted @@ -40,18 +57,23 @@ autogenerated autoloaded autoloader autoloading +automatable autoscale autoscaled autoscaler +autoscalers autoscales autoscaling +autovacuum awardable awardables Axios Ayoa +AZs Azure B-tree backfilling +backfills backport backported backporting @@ -61,11 +83,16 @@ backtraced backtraces backtracing badging +balancer +balancer's Bamboo Bazel +bcrypt +Beamer Bhyve Bitbucket Bitnami +Bittrex blockquote blockquoted blockquotes @@ -73,6 +100,8 @@ blockquoting boolean booleans Bootsnap +bot +bot's Bottlerocket browsable bugfix @@ -80,6 +109,7 @@ bugfixed bugfixes bugfixing Bugzilla +Buildah Buildkite buildpack buildpacks @@ -88,15 +118,24 @@ bundlers burndown burnup burstable +CA cacheable Caddy +callout +callouts callstack callstacks +camelCase +camelCased Camo canonicalization canonicalized captcha +CAPTCHAs +Capybara Casdoor +CDNs +CE CentOS Ceph Certbot @@ -110,28 +149,59 @@ ChaosKube chatbot chatbots ChatOps +checksummable checksummed checksumming Chemlab +chipset +chipsets +CIDRs Citrix Citus +Civo +Cleartext +ClickHouse +CLIs +Clojars clonable Cloudwatch +clusterized +CMake +CMK +CMKs +CNAs +CNs Cobertura Codeception +Codecov +codenames Codepen +CodeSandbox Cognito +Coinbase +colocate colocated colocating +commit's +CommonMark compilable composable composables Conda +config +Configs Consul Contentful Corosync +corpuses +Cosign Coursier +CPU +CPUs +CRAN +CRI-O cron +crond cronjob cronjobs crons @@ -142,31 +212,55 @@ crosslinking crosslinks Crossplane Crowdin +crypto +CSSComb CSV +CSVs +CTAs +CTEs +CUnit customappsso +CVEs +CWEs cybersecurity +CycloneDX Dangerfile +DAST +Database Lab Engine +Database Lab +Databricks Datadog datasource datasources +datastore +datastores +datestamp datetime +DBeaver Debian +debloating +decodable Decompressor decryptable +dedupe deduplicate deduplicated deduplicates deduplicating deduplication +delegators deliverables +denormalization denormalize denormalized denormalizes denormalizing +dentry denylist denylisted denylisting denylists +Depesz deployer deployers deprovision @@ -180,37 +274,67 @@ deserialization deserialize deserializers deserializes +desugar +desugars +desynchronized +Dev +devfile +devfiles DevOps Dhall +dialogs disambiguates discoverability dismissable Disqus Distroless Divio +DLE +DNs +Docker Dockerfile Dockerfiles Dockerize Dockerized Dockerizing +Docusaurus dogfood dogfooding dogfoods +DOMPurify dotenv +doublestar downvoted downvotes Dpl +dput Dreamweaver +DRIs +DSLs +DSN +Dynatrace Ecto +eden +EGit ElastiCache Elasticsearch +Eleventy enablement +Encrypt enqueued enqueues +enricher +enrichers enum enums +Enviroments +ESLint +ESXi ETag +ETags +Etsy Excon +exfiltrate exfiltration ExifTool expirable @@ -220,35 +344,52 @@ failovers failsafe Falco falsy +Fanout Fargate fastlane +Fastly Fastzip favicon favorited +Fediverse +ffaker Figma Filebeat +Filestore +Finicity +Finnhub Fio firewalled firewalling fixup +flamegraph +flamegraphs Flawfinder -Flowdock +Flickr Fluentd +Flutterwave Flycheck +focusable Forgerock formatters Fortinet +FQDNs +FreshBooks +frontend Fugit +Fulcio fuzzer +fuzzing Gantt Gbps Gemfile Gemnasium Gemojione Getter -getters Getters gettext +GIDs +gists Git Gitaly Gitea @@ -258,25 +399,34 @@ gitlabsos Gitleaks Gitpod Gitter +GLab globals +globbing +globstar +globstars Gmail Godep +Golang Gollum Google goroutine goroutines Gosec +GPUs Gradle Grafana Grafonnet gravatar Grype +GUIs Gzip Hackathon Haml +HAProxy hardcode hardcoded hardcodes +HashiCorp Haswell heatmap heatmaps @@ -284,6 +434,8 @@ Helm Helmfile Heroku Herokuish +heuristical +hexdigest Hexo HipChat hostname @@ -292,21 +444,35 @@ hotfix hotfixed hotfixes hotfixing +hotspots +HTMLHint http https +hyperparameter +hyperparameters +iCalendar +iCloud idempotence idmapper Iglu +IIFEs Immer inclusivity +inflector +inflectors Ingress initializer initializers +injective innersource innersourcing +inodes interdependencies interdependency interruptible +inviter +IPs +IPython irker issuables Istio @@ -317,16 +483,23 @@ JavaScript Jenkins Jenkinsfile Jira +Jitsu jq jQuery +JRuby +JSDoc jsdom Jsonnet +JUnit JupyterHub +JWT +JWTs Kaminari kanban kanbans kaniko Karma +KCachegrind Kerberos Keycloak keyset @@ -337,20 +510,29 @@ Kibana Kinesis Klar Knative +KPIs Kramdown Kroki +kubeconfig Kubecost kubectl Kubernetes Kubesec +Kucoin Kustomize +Kustomization +kwargs Laravel +LaunchDarkly ldapsearch Lefthook Leiningen +Lemmy libFuzzer +Libgcrypt Libravatar liveness +lockfile lockfiles Lodash Lograge @@ -361,14 +543,19 @@ lookahead lookaheads lookbehind lookbehinds +Lookbook lookups loopback +Lua Lucene +macOS +Mailchimp Maildir Mailgun Mailroom Makefile Makefiles +malloc Markdown markdownlint Marketo @@ -380,14 +567,18 @@ mbox memoization memoize memoized +memoizes memoizing Memorystore mergeability mergeable metaprogramming +metric's +microformat Microsoft middleware middlewares +migratable migratus minikube MinIO @@ -401,6 +592,8 @@ mitigations mitmproxy mixin mixins +MLflow +Mmap mockup mockups ModSecurity @@ -408,81 +601,126 @@ Monokai monorepo monorepos monospace +MRs +MSBuild multiline mutex nameserver nameservers namespace +namespace's namespaced namespaces namespacing namespacings Nanoc +NAT +navigations negatable Netlify +NGINX +ngrok +njsscan Nokogiri nosniff noteable noteables npm +NuGet nullability nullable Nurtch +NVMe nyc OAuth +OCP Octokit offboarded offboarding offboards +OIDs +OKRs +OKRs Okta +OLM OmniAuth onboarding OpenID OpenShift +OpenTelemetry Opsgenie +Opstrace +ORMs +OS +OSs +OTel outdent Overcommit Packagist +packfile +packfiles +Packwerk +paginator parallelization parallelizations +parsable +PascalCase +PascalCased +passthrough +passthroughs passwordless Patroni +PDFs performant PgBouncer +pgFormatter pgLoader +pgMustard Phabricator phaser phasers phpenv +PHPUnit +PIDs pipenv Pipfile Pipfiles Piwik plaintext +podman Poedit polyfill polyfills pooler postfixed +Postgres postgres.ai PostgreSQL +Praefect's +prebuild +prebuilds precompile precompiled preconfigure preconfigured preconfigures +prefetch +prefetching prefill prefilled prefilling prefills preload +preloaded preloading preloads prepend prepended prepending prepends +prepopulate prepopulated +presentationals Prettifier Pritaly Priyanka @@ -499,15 +737,20 @@ pseudocode pseudonymization pseudonymized pseudonymizer +Pulumi Puma +Pumble +PyPI pytest Python Qualys queryable Quicktime Rackspace +railties Raspbian rbenv +rbspy rbtrace Rclone Rdoc @@ -523,7 +766,9 @@ rebase rebased rebases rebasing +rebinding reCAPTCHA +recoverability Redcarpet redirection redirections @@ -534,25 +779,37 @@ referer referers reflog reflogs +refname refspec refspecs +regexes +Rego +reimplementation +reimplemented reindex reindexed reindexes reindexing reinitialize reinitializing +Rekor relicensing remediations renderers +renderless replicables repmgr repmgrd +reposts repurposing +requestee +requesters requeue requeued requeues requeuing +resolver +resolver's Restlet resync resynced @@ -566,10 +823,16 @@ reusability reverified reverifies reverify +reviewee +RIs roadmap roadmaps +rock rollout rollouts +routable +RPCs +RSpec rsync rsynced rsyncing @@ -578,6 +841,8 @@ Rubinius Rubix RuboCop Rubular +RubyGems +Rugged ruleset rulesets runbook @@ -588,13 +853,23 @@ runtimes Salesforce sandboxing sanitization +SBOMs sbt +SBT +scalar's scalers scatterplot scatterplots +schedulable Schemastore +scriptable scrollable +SDKs +segmentations +SELinux Semgrep +Sendbird +Sendinblue Sendmail Sentry serializer @@ -603,22 +878,33 @@ serializing serverless setuptools severities +SFCs sharded sharding +SHAs shfmt Shimo +Shippo Shopify Sidekiq +Sigstore Silverlight Sisense Sitespeed skippable +skopeo Slack Slackbot +SLAs +SLIs Slony +SLOs smartcard smartcards +snake_case +snake_cased snapshotting +Snowplow Snyk Sobelow Solargraph @@ -628,9 +914,14 @@ Spamcheck spammable sparkline sparklines +Speedscope spidering Splunk SpotBugs +Squarespace +SREs +SSDs +SSGs Stackdriver Stackprof starrer @@ -646,6 +937,7 @@ subchart subcharts subcommand subcommands +subcomponent subfolder subfolders subgraph @@ -658,6 +950,8 @@ sublicense sublicensed sublicenses sublicensing +submodule +submodule's subnet subnets subnetting @@ -668,21 +962,27 @@ subqueried subqueries subquery subquerying +Subreddit substring substrings subtask subtasks subtest subtests +subtransaction +subtransactions subtree subtrees sudo +sunsetting supercookie supercookies +supergroup superset supersets supertype supertypes +SVGs swappiness swimlane swimlanes @@ -692,11 +992,15 @@ syscall syscalls syslog systemd +tablespace +tablespaces tanuki +taskscaler tcpdump +teardown templated Thanos -Thoughtbot +thoughtbot throughputs Tiller timebox @@ -704,7 +1008,9 @@ timeboxed timeboxes timeboxing timecop -tiptap +timelog +timelogs +Tiptap todos tokenizer Tokenizers @@ -714,6 +1020,7 @@ toolchain toolchains toolkit toolkits +toolset tooltip tooltips transactionally @@ -722,6 +1029,7 @@ transpiled transpiles transpiling Trello +Trendline triaged triages triaging @@ -730,9 +1038,13 @@ Truststore truthy Twilio Twitter +Typeform TypeScript +TZInfo Ubuntu Udemy +UI +UIDs unapplied unapprove unapproved @@ -746,6 +1058,8 @@ unassign unassigning unassigns unban +unbans +uncached uncheck unchecked unchecking @@ -754,11 +1068,13 @@ uncomment uncommented uncommenting uncordon +underperforming unencode unencoded unencoder unencodes unencrypted +unescaped unfollow unfollowed unfollows @@ -778,7 +1094,9 @@ unoptimize unoptimized unoptimizes unoptimizing +unparsable unpatched +unpause unprioritized unprotect unprotected @@ -791,6 +1109,7 @@ unpublish unpublished unpublishes unpublishing +unpullable unpushed unreferenced unregister @@ -801,9 +1120,11 @@ unresolve unresolved unresolving unreviewed +unrevoke unsanitized unschedule unscoped +unsetting unshare unshared unshares @@ -832,10 +1153,14 @@ upstreams upvote upvoted upvotes +urgencies URIs +URL +UUIDs Vagrantfile validator validators +vCPUs vendored vendoring versionless @@ -843,13 +1168,18 @@ viewport viewports virtualized virtualizing +Vite +VMs +VPCs Vue Vuex +waitlist walkthrough walkthroughs WebdriverIO Webex webpack +WEBrick webserver Webservice websocket @@ -863,17 +1193,23 @@ wireframing Wireshark Wordpress Workato +workstream worktree worktrees Worldline Xcode Xeon +XPath +Yandex YouTrack ytt Yubico Zabbix +ZAProxy Zeitwerk Zendesk ZenTao +Zoekt zsh Zstandard +Zuora diff --git a/docs/release_process.md b/docs/release_process.md index 12441ce7..6e61d407 100644 --- a/docs/release_process.md +++ b/docs/release_process.md @@ -34,7 +34,7 @@ To manually update the version available through Homebrew: ```shell brew bump-formula-pr --strict glab \ - --url=https://gitlab.com/gitlab-org/cli/-/archive/v1.23.0/cli-v1.23.0.tar.gz \ + --url="https://gitlab.com/gitlab-org/cli/-/archive/v1.23.0/cli-v1.23.0.tar.gz" \ --sha256=4fe9dcecc5e601a849454a3608b47d709b11e2df81527f666b169e0dd362d7df ``` diff --git a/docs/source/alias/index.md b/docs/source/alias/index.md index 83ed022b..1120eb01 100644 --- a/docs/source/alias/index.md +++ b/docs/source/alias/index.md @@ -21,6 +21,6 @@ Create, list and delete aliases ## Subcommands -- [delete](delete.md) -- [list](list.md) -- [set](set.md) +- [`delete`](delete.md) +- [`list`](list.md) +- [`set`](set.md) diff --git a/docs/source/ask/index.md b/docs/source/ask/index.md index 05498cb5..f4dc3d09 100644 --- a/docs/source/ask/index.md +++ b/docs/source/ask/index.md @@ -21,4 +21,4 @@ Generate terminal commands from natural language. (Experimental.) ## Subcommands -- [git](git.md) +- [`git`](git.md) diff --git a/docs/source/auth/index.md b/docs/source/auth/index.md index fbce6bfb..ba3a034b 100644 --- a/docs/source/auth/index.md +++ b/docs/source/auth/index.md @@ -21,6 +21,6 @@ Manage glab's authentication state ## Subcommands -- [git-credential](git-credential.md) -- [login](login.md) -- [status](status.md) +- [`git-credential`](git-credential.md) +- [`login`](login.md) +- [`status`](status.md) diff --git a/docs/source/changelog/index.md b/docs/source/changelog/index.md index c22e747b..e73172a0 100644 --- a/docs/source/changelog/index.md +++ b/docs/source/changelog/index.md @@ -21,4 +21,4 @@ Interact with the changelog API ## Subcommands -- [generate](generate.md) +- [`generate`](generate.md) diff --git a/docs/source/ci/ci/index.md b/docs/source/ci/ci/index.md index a7f071d4..674446d7 100644 --- a/docs/source/ci/ci/index.md +++ b/docs/source/ci/ci/index.md @@ -29,6 +29,6 @@ glab pipeline ci trace ## Subcommands -- [lint](lint.md) -- [trace](trace.md) -- [view](view.md) +- [`lint`](lint.md) +- [`trace`](trace.md) +- [`view`](view.md) diff --git a/docs/source/ci/index.md b/docs/source/ci/index.md index debcd9ec..07d7d457 100644 --- a/docs/source/ci/index.md +++ b/docs/source/ci/index.md @@ -34,14 +34,14 @@ pipeline ## Subcommands -- [artifact](artifact.md) -- [ci](ci/index.md) -- [delete](delete.md) -- [get](get.md) -- [lint](lint.md) -- [list](list.md) -- [retry](retry.md) -- [run](run.md) -- [status](status.md) -- [trace](trace.md) -- [view](view.md) +- [`artifact`](artifact.md) +- [`ci`](ci/index.md) +- [`delete`](delete.md) +- [`get`](get.md) +- [`lint`](lint.md) +- [`list`](list.md) +- [`retry`](retry.md) +- [`run`](run.md) +- [`status`](status.md) +- [`trace`](trace.md) +- [`view`](view.md) diff --git a/docs/source/cluster/agent/index.md b/docs/source/cluster/agent/index.md index 4cca2d64..5d556587 100644 --- a/docs/source/cluster/agent/index.md +++ b/docs/source/cluster/agent/index.md @@ -27,6 +27,6 @@ Manage GitLab Agents for Kubernetes ## Subcommands -- [get-token](get-token.md) -- [list](list.md) -- [update-kubeconfig](update-kubeconfig.md) +- [`get-token`](get-token.md) +- [`list`](list.md) +- [`update-kubeconfig`](update-kubeconfig.md) diff --git a/docs/source/cluster/index.md b/docs/source/cluster/index.md index 4504a903..e090d4c0 100644 --- a/docs/source/cluster/index.md +++ b/docs/source/cluster/index.md @@ -27,4 +27,4 @@ Manage GitLab Agents for Kubernetes and their clusters ## Subcommands -- [agent](agent/index.md) +- [`agent`](agent/index.md) diff --git a/docs/source/completion/index.md b/docs/source/completion/index.md index 6e3502f5..67f3b6cb 100644 --- a/docs/source/completion/index.md +++ b/docs/source/completion/index.md @@ -15,7 +15,7 @@ Generate shell completion scripts ## Synopsis -The output of this command will be computer code and is meant to be saved +The output of this command will be computer code and is meant to be saved to a file or immediately evaluated by an interactive shell. To load completions: ### Bash @@ -96,10 +96,10 @@ glab completion -s powershell | Out-String | Invoke-Expression ``` To load completions for every new session, add the output of the above command -to your powershell profile. +to your PowerShell profile. When installing glab through a package manager, however, it's possible that -no additional shell configuration is necessary to gain completion support. +no additional shell configuration is necessary to gain completion support. For Homebrew, see ```plaintext diff --git a/docs/source/config/index.md b/docs/source/config/index.md index 73e840f1..3fe19213 100644 --- a/docs/source/config/index.md +++ b/docs/source/config/index.md @@ -49,6 +49,6 @@ conf ## Subcommands -- [get](get.md) -- [init](init.md) -- [set](set.md) +- [`get`](get.md) +- [`init`](init.md) +- [`set`](set.md) diff --git a/docs/source/incident/index.md b/docs/source/incident/index.md index 073e7ce3..8557ceeb 100644 --- a/docs/source/incident/index.md +++ b/docs/source/incident/index.md @@ -34,10 +34,10 @@ glab incident list ## Subcommands -- [close](close.md) -- [list](list.md) -- [note](note.md) -- [reopen](reopen.md) -- [subscribe](subscribe.md) -- [unsubscribe](unsubscribe.md) -- [view](view.md) +- [`close`](close.md) +- [`list`](list.md) +- [`note`](note.md) +- [`reopen`](reopen.md) +- [`subscribe`](subscribe.md) +- [`unsubscribe`](unsubscribe.md) +- [`view`](view.md) diff --git a/docs/source/index.md b/docs/source/index.md index 9164b72c..e71afb3b 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -80,6 +80,5 @@ to send us feedback. ## Related topics - [Install the CLI](https://gitlab.com/gitlab-org/cli/-/blob/main/README.md#installation) -- [Documentation](https://gitlab.com/gitlab-org/cli/-/tree/main/docs/source) - The extension source code is available in the [`cli`](https://gitlab.com/gitlab-org/cli/) project. diff --git a/docs/source/issue/board/index.md b/docs/source/issue/board/index.md index 4d242d65..f16a69ab 100644 --- a/docs/source/issue/board/index.md +++ b/docs/source/issue/board/index.md @@ -27,5 +27,5 @@ Work with GitLab Issue Boards in the given project. ## Subcommands -- [create](create.md) -- [view](view.md) +- [`create`](create.md) +- [`view`](view.md) diff --git a/docs/source/issue/index.md b/docs/source/issue/index.md index 44b45be3..0fcfcfcd 100644 --- a/docs/source/issue/index.md +++ b/docs/source/issue/index.md @@ -37,14 +37,14 @@ glab issue note -m "closing because !123 was merged" ## Subcommands -- [board](board/index.md) -- [close](close.md) -- [create](create.md) -- [delete](delete.md) -- [list](list.md) -- [note](note.md) -- [reopen](reopen.md) -- [subscribe](subscribe.md) -- [unsubscribe](unsubscribe.md) -- [update](update.md) -- [view](view.md) +- [`board`](board/index.md) +- [`close`](close.md) +- [`create`](create.md) +- [`delete`](delete.md) +- [`list`](list.md) +- [`note`](note.md) +- [`reopen`](reopen.md) +- [`subscribe`](subscribe.md) +- [`unsubscribe`](unsubscribe.md) +- [`update`](update.md) +- [`view`](view.md) diff --git a/docs/source/label/index.md b/docs/source/label/index.md index ac259baa..e37e0014 100644 --- a/docs/source/label/index.md +++ b/docs/source/label/index.md @@ -27,5 +27,5 @@ Manage labels on remote ## Subcommands -- [create](create.md) -- [list](list.md) +- [`create`](create.md) +- [`list`](list.md) diff --git a/docs/source/mr/index.md b/docs/source/mr/index.md index b088b7a6..6973243c 100644 --- a/docs/source/mr/index.md +++ b/docs/source/mr/index.md @@ -36,23 +36,23 @@ glab mr note -m "needs to do X before it can be merged" branch-foo ## Subcommands -- [approve](approve.md) -- [approvers](approvers.md) -- [checkout](checkout.md) -- [close](close.md) -- [create](create.md) -- [delete](delete.md) -- [diff](diff.md) -- [for](for.md) -- [issues](issues.md) -- [list](list.md) -- [merge](merge.md) -- [note](note.md) -- [rebase](rebase.md) -- [reopen](reopen.md) -- [revoke](revoke.md) -- [subscribe](subscribe.md) -- [todo](todo.md) -- [unsubscribe](unsubscribe.md) -- [update](update.md) -- [view](view.md) +- [`approve`](approve.md) +- [`approvers`](approvers.md) +- [`checkout`](checkout.md) +- [`close`](close.md) +- [`create`](create.md) +- [`delete`](delete.md) +- [`diff`](diff.md) +- [`for`](for.md) +- [`issues`](issues.md) +- [`list`](list.md) +- [`merge`](merge.md) +- [`note`](note.md) +- [`rebase`](rebase.md) +- [`reopen`](reopen.md) +- [`revoke`](revoke.md) +- [`subscribe`](subscribe.md) +- [`todo`](todo.md) +- [`unsubscribe`](unsubscribe.md) +- [`update`](update.md) +- [`view`](view.md) diff --git a/docs/source/release/index.md b/docs/source/release/index.md index 11afc4df..8737024f 100644 --- a/docs/source/release/index.md +++ b/docs/source/release/index.md @@ -27,9 +27,9 @@ Manage GitLab releases ## Subcommands -- [create](create.md) -- [delete](delete.md) -- [download](download.md) -- [list](list.md) -- [upload](upload.md) -- [view](view.md) +- [`create`](create.md) +- [`delete`](delete.md) +- [`download`](download.md) +- [`list`](list.md) +- [`upload`](upload.md) +- [`view`](view.md) diff --git a/docs/source/repo/index.md b/docs/source/repo/index.md index fc731b3d..0b1179c7 100644 --- a/docs/source/repo/index.md +++ b/docs/source/repo/index.md @@ -27,14 +27,14 @@ project ## Subcommands -- [archive](archive.md) -- [clone](clone.md) -- [contributors](contributors.md) -- [create](create.md) -- [delete](delete.md) -- [fork](fork.md) -- [list](list.md) -- [mirror](mirror.md) -- [search](search.md) -- [transfer](transfer.md) -- [view](view.md) +- [`archive`](archive.md) +- [`clone`](clone.md) +- [`contributors`](contributors.md) +- [`create`](create.md) +- [`delete`](delete.md) +- [`fork`](fork.md) +- [`list`](list.md) +- [`mirror`](mirror.md) +- [`search`](search.md) +- [`transfer`](transfer.md) +- [`view`](view.md) diff --git a/docs/source/schedule/index.md b/docs/source/schedule/index.md index f85ca3d0..bd3e01a0 100644 --- a/docs/source/schedule/index.md +++ b/docs/source/schedule/index.md @@ -34,7 +34,7 @@ skd ## Subcommands -- [create](create.md) -- [delete](delete.md) -- [list](list.md) -- [run](run.md) +- [`create`](create.md) +- [`delete`](delete.md) +- [`list`](list.md) +- [`run`](run.md) diff --git a/docs/source/snippet/index.md b/docs/source/snippet/index.md index e1d04f48..79c4076f 100644 --- a/docs/source/snippet/index.md +++ b/docs/source/snippet/index.md @@ -34,4 +34,4 @@ glab snippet create --title "Title of the snippet" --filename "main.go" ## Subcommands -- [create](create.md) +- [`create`](create.md) diff --git a/docs/source/ssh-key/index.md b/docs/source/ssh-key/index.md index ee1205a0..da1cc925 100644 --- a/docs/source/ssh-key/index.md +++ b/docs/source/ssh-key/index.md @@ -27,7 +27,7 @@ Manage SSH keys registered with your GitLab account. ## Subcommands -- [add](add.md) -- [delete](delete.md) -- [get](get.md) -- [list](list.md) +- [`add`](add.md) +- [`delete`](delete.md) +- [`get`](get.md) +- [`list`](list.md) diff --git a/docs/source/user/index.md b/docs/source/user/index.md index 039fb2d1..2aa0adc0 100644 --- a/docs/source/user/index.md +++ b/docs/source/user/index.md @@ -21,4 +21,4 @@ Interact with user ## Subcommands -- [events](events.md) +- [`events`](events.md) diff --git a/docs/source/variable/index.md b/docs/source/variable/index.md index e107f697..6f7165b2 100644 --- a/docs/source/variable/index.md +++ b/docs/source/variable/index.md @@ -33,9 +33,9 @@ var ## Subcommands -- [delete](delete.md) -- [export](export.md) -- [get](get.md) -- [list](list.md) -- [set](set.md) -- [update](update.md) +- [`delete`](delete.md) +- [`export`](export.md) +- [`get`](get.md) +- [`list`](list.md) +- [`set`](set.md) +- [`update`](update.md)