diff --git a/.markdownlint.yml b/.markdownlint.yml index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_Lm1hcmtkb3dubGludC55bWw=..0d2fe2cb88263d98f2057a1fd0d57ca87e13e925_Lm1hcmtkb3dubGludC55bWw= 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -33,7 +33,6 @@ "API", "Asana", "Auth0", - "Authentiq", "Azure", "Bamboo", "Bitbucket", @@ -109,6 +108,7 @@ "PgBouncer", "Postfix", "PostgreSQL", + "PowerShell", "Praefect", "Prometheus", "Puma", diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml deleted file mode 100644 index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_ZG9jLy52YWxlL2dpdGxhYi9BZG1pbi55bWw=..0000000000000000000000000000000000000000 --- a/doc/.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://vale.sh/docs/topics/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/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab/HeadingDepth.yml index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_ZG9jLy52YWxlL2dpdGxhYi9IZWFkaW5nRGVwdGgueW1s..0d2fe2cb88263d98f2057a1fd0d57ca87e13e925_ZG9jLy52YWxlL2dpdGxhYi9IZWFkaW5nRGVwdGgueW1s 100644 --- a/doc/.vale/gitlab/HeadingDepth.yml +++ b/doc/.vale/gitlab/HeadingDepth.yml @@ -6,7 +6,7 @@ # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Refactor the section or page to avoid headings greater than H5." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#headings-in-markdown +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#heading-levels-in-markdown level: suggestion scope: raw raw: diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml deleted file mode 100644 index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_ZG9jLy52YWxlL2dpdGxhYi9TdWJzdGl0dXRpb25TdWdnZXN0aW9ucy55bWw=..0000000000000000000000000000000000000000 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ /dev/null @@ -1,29 +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://vale.sh/docs/topics/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: '"you should"' - we recommend: '"you should"' - 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/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_ZG9jLy52YWxlL2dpdGxhYi9zcGVsbGluZy1leGNlcHRpb25zLnR4dA==..0d2fe2cb88263d98f2057a1fd0d57ca87e13e925_ZG9jLy52YWxlL2dpdGxhYi9zcGVsbGluZy1leGNlcHRpb25zLnR4dA== 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -357,7 +357,6 @@ flamegraphs Flawfinder Flickr -Flowdock Fluentd Flutterwave Flycheck @@ -498,6 +497,7 @@ Kinesis Klar Knative +KPIs Kramdown Kroki kubeconfig @@ -618,6 +618,7 @@ NVMe nyc OAuth +OCP Octokit offboarded offboarding @@ -626,6 +627,7 @@ OKRs OKRs Okta +OLM OmniAuth onboarding OpenID @@ -669,6 +671,7 @@ Pipfiles Piwik plaintext +podman Poedit polyfill polyfills @@ -836,4 +839,5 @@ SBOMs sbt SBT +scalar's scalers @@ -839,5 +843,4 @@ scalers -scalar's scatterplot scatterplots schedulable @@ -1185,6 +1188,7 @@ Zeitwerk Zendesk ZenTao +Zoekt zsh Zstandard Zuora @@ -1188,4 +1192,3 @@ zsh Zstandard Zuora -Zoekt diff --git a/doc/settings/gitlab.yml.md b/doc/settings/gitlab.yml.md index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_ZG9jL3NldHRpbmdzL2dpdGxhYi55bWwubWQ=..0d2fe2cb88263d98f2057a1fd0d57ca87e13e925_ZG9jL3NldHRpbmdzL2dpdGxhYi55bWwubWQ= 100644 --- a/doc/settings/gitlab.yml.md +++ b/doc/settings/gitlab.yml.md @@ -14,7 +14,7 @@ New installations starting from GitLab 7.6 have all the options of the template listed in `/etc/gitlab/gitlab.rb` by default. -In `gitlab.yml`, you will find structure like this: +In `gitlab.yml`, you find structure like this: ```yaml production: &base @@ -37,7 +37,7 @@ Run `sudo gitlab-ctl reconfigure` for changes in `gitlab.rb` to take effect. Do not edit the generated file in `/var/opt/gitlab/gitlab-rails/etc/gitlab.yml` -since it will be overwritten on the next `gitlab-ctl reconfigure` run. +because it is overwritten on the next `gitlab-ctl reconfigure` run. ## Adding a new setting to `gitlab.yml` diff --git a/gitlab-ci-config/gitlab-com.yml b/gitlab-ci-config/gitlab-com.yml index 6bf56c9eea9cc89a3073d7e93bccd5839c17b442_Z2l0bGFiLWNpLWNvbmZpZy9naXRsYWItY29tLnltbA==..0d2fe2cb88263d98f2057a1fd0d57ca87e13e925_Z2l0bGFiLWNpLWNvbmZpZy9naXRsYWItY29tLnltbA== 100644 --- a/gitlab-ci-config/gitlab-com.yml +++ b/gitlab-ci-config/gitlab-com.yml @@ -295,7 +295,7 @@ # Perform documentation linting on Markdown files docs-lint markdown: - image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.16-vale-2.23.0-markdownlint-0.33.0-markdownlint2-0.6.0 + image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-markdown:alpine-3.17-vale-2.24.0-markdownlint-0.33.0-markdownlint2-0.6.0 stage: check cache: {} needs: [] @@ -312,7 +312,7 @@ # Perform link checks on published HTML files docs-lint links: - image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-html:alpine-3.16-ruby-3.0.5-2a7e4d1c + image: registry.gitlab.com/gitlab-org/gitlab-docs/lint-html:alpine-3.17-ruby-3.2.1-f53af000 stage: check cache: {} needs: []