diff --git a/.vale.ini b/.vale.ini index 3c6e0d38b52bfc635fd15c0607ebaeb13c806413..8d8dd99f17a5be20013366fc69a8943af80b9a39 100644 --- a/.vale.ini +++ b/.vale.ini @@ -6,7 +6,7 @@ StylesPath = doc/.vale MinAlertLevel = suggestion [*.md] -BasedOnStyles = gitlab +BasedOnStyles = gitlab_base, gitlab_docs # Ignore SVG markup TokenIgnores = (\*\*\{\w*\}\*\*) diff --git a/doc/.vale/gitlab/BadPlurals.yml b/doc/.vale/gitlab_base/BadPlurals.yml similarity index 100% rename from doc/.vale/gitlab/BadPlurals.yml rename to doc/.vale/gitlab_base/BadPlurals.yml diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab_base/British.yml similarity index 100% rename from doc/.vale/gitlab/British.yml rename to doc/.vale/gitlab_base/British.yml diff --git a/doc/.vale/gitlab/CIConfigFile.yml b/doc/.vale/gitlab_base/CIConfigFile.yml similarity index 100% rename from doc/.vale/gitlab/CIConfigFile.yml rename to doc/.vale/gitlab_base/CIConfigFile.yml diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab_base/CodeblockFences.yml similarity index 100% rename from doc/.vale/gitlab/CodeblockFences.yml rename to doc/.vale/gitlab_base/CodeblockFences.yml diff --git a/doc/.vale/gitlab/CommandStringsQuoted.yml b/doc/.vale/gitlab_base/CommandStringsQuoted.yml similarity index 100% rename from doc/.vale/gitlab/CommandStringsQuoted.yml rename to doc/.vale/gitlab_base/CommandStringsQuoted.yml diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab_base/CurrentStatus.yml similarity index 100% rename from doc/.vale/gitlab/CurrentStatus.yml rename to doc/.vale/gitlab_base/CurrentStatus.yml diff --git a/doc/.vale/gitlab/DefaultBranch.yml b/doc/.vale/gitlab_base/DefaultBranch.yml similarity index 100% rename from doc/.vale/gitlab/DefaultBranch.yml rename to doc/.vale/gitlab_base/DefaultBranch.yml diff --git a/doc/.vale/gitlab/Dropdown.yml b/doc/.vale/gitlab_base/Dropdown.yml similarity index 100% rename from doc/.vale/gitlab/Dropdown.yml rename to doc/.vale/gitlab_base/Dropdown.yml diff --git a/doc/.vale/gitlab/EOLWhitespace.yml b/doc/.vale/gitlab_base/EOLWhitespace.yml similarity index 100% rename from doc/.vale/gitlab/EOLWhitespace.yml rename to doc/.vale/gitlab_base/EOLWhitespace.yml diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab_base/ElementDescriptors.yml similarity index 100% rename from doc/.vale/gitlab/ElementDescriptors.yml rename to doc/.vale/gitlab_base/ElementDescriptors.yml diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab_base/FutureTense.yml similarity index 100% rename from doc/.vale/gitlab/FutureTense.yml rename to doc/.vale/gitlab_base/FutureTense.yml diff --git a/doc/.vale/gitlab/GitLabFlavoredMarkdown.yml b/doc/.vale/gitlab_base/GitLabFlavoredMarkdown.yml similarity index 100% rename from doc/.vale/gitlab/GitLabFlavoredMarkdown.yml rename to doc/.vale/gitlab_base/GitLabFlavoredMarkdown.yml diff --git a/doc/.vale/gitlab/HeadingContent.yml b/doc/.vale/gitlab_base/HeadingContent.yml similarity index 100% rename from doc/.vale/gitlab/HeadingContent.yml rename to doc/.vale/gitlab_base/HeadingContent.yml diff --git a/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab_base/HeadingDepth.yml similarity index 100% rename from doc/.vale/gitlab/HeadingDepth.yml rename to doc/.vale/gitlab_base/HeadingDepth.yml diff --git a/doc/.vale/gitlab/HeadingLink.yml b/doc/.vale/gitlab_base/HeadingLink.yml similarity index 100% rename from doc/.vale/gitlab/HeadingLink.yml rename to doc/.vale/gitlab_base/HeadingLink.yml diff --git a/doc/.vale/gitlab/InclusiveLanguage.yml b/doc/.vale/gitlab_base/InclusiveLanguage.yml similarity index 100% rename from doc/.vale/gitlab/InclusiveLanguage.yml rename to doc/.vale/gitlab_base/InclusiveLanguage.yml diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab_base/LatinTerms.yml similarity index 100% rename from doc/.vale/gitlab/LatinTerms.yml rename to doc/.vale/gitlab_base/LatinTerms.yml diff --git a/doc/.vale/gitlab/Level.yml b/doc/.vale/gitlab_base/Level.yml similarity index 100% rename from doc/.vale/gitlab/Level.yml rename to doc/.vale/gitlab_base/Level.yml diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab_base/MeaningfulLinkWords.yml similarity index 100% rename from doc/.vale/gitlab/MeaningfulLinkWords.yml rename to doc/.vale/gitlab_base/MeaningfulLinkWords.yml diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab_base/MergeConflictMarkers.yml similarity index 100% rename from doc/.vale/gitlab/MergeConflictMarkers.yml rename to doc/.vale/gitlab_base/MergeConflictMarkers.yml diff --git a/doc/.vale/gitlab/MultiLineLinks.yml b/doc/.vale/gitlab_base/MultiLineLinks.yml similarity index 100% rename from doc/.vale/gitlab/MultiLineLinks.yml rename to doc/.vale/gitlab_base/MultiLineLinks.yml diff --git a/doc/.vale/gitlab/NonStandardQuotes.yml b/doc/.vale/gitlab_base/NonStandardQuotes.yml similarity index 100% rename from doc/.vale/gitlab/NonStandardQuotes.yml rename to doc/.vale/gitlab_base/NonStandardQuotes.yml diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab_base/OutdatedVersions.yml similarity index 100% rename from doc/.vale/gitlab/OutdatedVersions.yml rename to doc/.vale/gitlab_base/OutdatedVersions.yml diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab_base/OxfordComma.yml similarity index 100% rename from doc/.vale/gitlab/OxfordComma.yml rename to doc/.vale/gitlab_base/OxfordComma.yml diff --git a/doc/.vale/gitlab/Possessive.yml b/doc/.vale/gitlab_base/Possessive.yml similarity index 100% rename from doc/.vale/gitlab/Possessive.yml rename to doc/.vale/gitlab_base/Possessive.yml diff --git a/doc/.vale/gitlab/Prerequisites.yml b/doc/.vale/gitlab_base/Prerequisites.yml similarity index 100% rename from doc/.vale/gitlab/Prerequisites.yml rename to doc/.vale/gitlab_base/Prerequisites.yml diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab_base/ReadingLevel.yml similarity index 100% rename from doc/.vale/gitlab/ReadingLevel.yml rename to doc/.vale/gitlab_base/ReadingLevel.yml diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab_base/Repetition.yml similarity index 100% rename from doc/.vale/gitlab/Repetition.yml rename to doc/.vale/gitlab_base/Repetition.yml diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab_base/SentenceLength.yml similarity index 100% rename from doc/.vale/gitlab/SentenceLength.yml rename to doc/.vale/gitlab_base/SentenceLength.yml diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab_base/SentenceSpacing.yml similarity index 100% rename from doc/.vale/gitlab/SentenceSpacing.yml rename to doc/.vale/gitlab_base/SentenceSpacing.yml diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab_base/Simplicity.yml similarity index 100% rename from doc/.vale/gitlab/Simplicity.yml rename to doc/.vale/gitlab_base/Simplicity.yml diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab_base/Spelling.yml similarity index 94% rename from doc/.vale/gitlab/Spelling.yml rename to doc/.vale/gitlab_base/Spelling.yml index 74d919831ace85f400847fb4dee96317efd8d76e..459803d9d57134876151e002fa26cc89551b795b 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab_base/Spelling.yml @@ -13,4 +13,4 @@ extends: spelling 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 + - gitlab_base/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab_base/SubstitutionWarning.yml similarity index 100% rename from doc/.vale/gitlab/SubstitutionWarning.yml rename to doc/.vale/gitlab_base/SubstitutionWarning.yml diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab_base/Substitutions.yml similarity index 100% rename from doc/.vale/gitlab/Substitutions.yml rename to doc/.vale/gitlab_base/Substitutions.yml diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab_base/ToDo.yml similarity index 100% rename from doc/.vale/gitlab/ToDo.yml rename to doc/.vale/gitlab_base/ToDo.yml diff --git a/doc/.vale/gitlab/UnclearAntecedent.yml b/doc/.vale/gitlab_base/UnclearAntecedent.yml similarity index 100% rename from doc/.vale/gitlab/UnclearAntecedent.yml rename to doc/.vale/gitlab_base/UnclearAntecedent.yml diff --git a/doc/.vale/gitlab/Units.yml b/doc/.vale/gitlab_base/Units.yml similarity index 100% rename from doc/.vale/gitlab/Units.yml rename to doc/.vale/gitlab_base/Units.yml diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab_base/Uppercase.yml similarity index 100% rename from doc/.vale/gitlab/Uppercase.yml rename to doc/.vale/gitlab_base/Uppercase.yml diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab_base/Wordy.yml similarity index 100% rename from doc/.vale/gitlab/Wordy.yml rename to doc/.vale/gitlab_base/Wordy.yml diff --git a/doc/.vale/gitlab/Zip.yml b/doc/.vale/gitlab_base/Zip.yml similarity index 100% rename from doc/.vale/gitlab/Zip.yml rename to doc/.vale/gitlab_base/Zip.yml diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab_base/spelling-exceptions.txt similarity index 100% rename from doc/.vale/gitlab/spelling-exceptions.txt rename to doc/.vale/gitlab_base/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab_docs/AlertBoxStyle.yml similarity index 100% rename from doc/.vale/gitlab/AlertBoxStyle.yml rename to doc/.vale/gitlab_docs/AlertBoxStyle.yml diff --git a/doc/.vale/gitlab/Badges-Offerings.yml b/doc/.vale/gitlab_docs/Badges-Offerings.yml similarity index 100% rename from doc/.vale/gitlab/Badges-Offerings.yml rename to doc/.vale/gitlab_docs/Badges-Offerings.yml diff --git a/doc/.vale/gitlab/Badges-Tiers.yml b/doc/.vale/gitlab_docs/Badges-Tiers.yml similarity index 100% rename from doc/.vale/gitlab/Badges-Tiers.yml rename to doc/.vale/gitlab_docs/Badges-Tiers.yml diff --git a/doc/.vale/gitlab/HistoryItems.yml b/doc/.vale/gitlab_docs/HistoryItems.yml similarity index 100% rename from doc/.vale/gitlab/HistoryItems.yml rename to doc/.vale/gitlab_docs/HistoryItems.yml diff --git a/doc/.vale/gitlab/HistoryItemsOrder.yml b/doc/.vale/gitlab_docs/HistoryItemsOrder.yml similarity index 100% rename from doc/.vale/gitlab/HistoryItemsOrder.yml rename to doc/.vale/gitlab_docs/HistoryItemsOrder.yml diff --git a/doc/.vale/gitlab/InternalLinkCase.yml b/doc/.vale/gitlab_docs/InternalLinkCase.yml similarity index 100% rename from doc/.vale/gitlab/InternalLinkCase.yml rename to doc/.vale/gitlab_docs/InternalLinkCase.yml diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab_docs/InternalLinkExtension.yml similarity index 100% rename from doc/.vale/gitlab/InternalLinkExtension.yml rename to doc/.vale/gitlab_docs/InternalLinkExtension.yml diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab_docs/InternalLinkFormat.yml similarity index 100% rename from doc/.vale/gitlab/InternalLinkFormat.yml rename to doc/.vale/gitlab_docs/InternalLinkFormat.yml diff --git a/doc/.vale/gitlab/InternalLinksCode.yml b/doc/.vale/gitlab_docs/InternalLinksCode.yml similarity index 100% rename from doc/.vale/gitlab/InternalLinksCode.yml rename to doc/.vale/gitlab_docs/InternalLinksCode.yml diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab_docs/ReferenceLinks.yml similarity index 100% rename from doc/.vale/gitlab/ReferenceLinks.yml rename to doc/.vale/gitlab_docs/ReferenceLinks.yml diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab_docs/RelativeLinks.yml similarity index 100% rename from doc/.vale/gitlab/RelativeLinks.yml rename to doc/.vale/gitlab_docs/RelativeLinks.yml diff --git a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml similarity index 100% rename from doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml rename to doc/.vale/gitlab_docs/RelativeLinksDoubleSlashes.yml diff --git a/doc/.vale/gitlab/TabsLinks.yml b/doc/.vale/gitlab_docs/TabsLinks.yml similarity index 100% rename from doc/.vale/gitlab/TabsLinks.yml rename to doc/.vale/gitlab_docs/TabsLinks.yml diff --git a/doc/administration/auth/ldap/ldap_synchronization.md b/doc/administration/auth/ldap/ldap_synchronization.md index 569eee3dddbefad4d81fddc848e46bdea589852d..8f6dad1b0078a4fdc421e841728e60fab6cec234 100644 --- a/doc/administration/auth/ldap/ldap_synchronization.md +++ b/doc/administration/auth/ldap/ldap_synchronization.md @@ -35,11 +35,11 @@ In Active Directory, a user is marked as disabled/blocked if the user account control attribute (`userAccountControl:1.2.840.113556.1.4.803`) has bit 2 set. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> For more information, see [Bitmask Searches in LDAP](https://ctovswild.com/2009/09/03/bitmask-searches-in-ldap/). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> The process also updates the following user information: diff --git a/doc/administration/geo/replication/geo_validation_tests.md b/doc/administration/geo/replication/geo_validation_tests.md index 6068522c301e8cd2860c16b0c44555fe070e3b2d..a92a48db68d58c378efcdb9c2e576e89b48ad78b 100644 --- a/doc/administration/geo/replication/geo_validation_tests.md +++ b/doc/administration/geo/replication/geo_validation_tests.md @@ -19,7 +19,7 @@ This section contains a journal of validation tests and links to the relevant is The following are GitLab upgrade validation tests we performed. -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> ### July 2020 diff --git a/doc/administration/instance_review.md b/doc/administration/instance_review.md index cd67ee34a12ba97a4a312c223e22eadfa59b1ae8..e108e65f13c2f694e4abb0a20de993d8abdd40df 100644 --- a/doc/administration/instance_review.md +++ b/doc/administration/instance_review.md @@ -14,12 +14,12 @@ If you run a self-managed instance with 50 or more users on the Free tier ([either Community Edition or unlicensed Enterprise Edition](https://about.gitlab.com/install/ce-or-ee/)), you can request a free instance review. -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> After you submit the request, a GitLab team member will review your instance details and contact you with suggestions to improve your use of GitLab. -<!-- vale gitlab.FutureTense = YES --> +<!-- vale gitlab_base.FutureTense = YES --> To request an instance review: diff --git a/doc/administration/integration/kroki.md b/doc/administration/integration/kroki.md index f7242ba88d6396300b31d373e40be4fc3d01b87f..499862ead18217296cfa85f74f1734c49b3ca7e5 100644 --- a/doc/administration/integration/kroki.md +++ b/doc/administration/integration/kroki.md @@ -46,7 +46,7 @@ types out of the box. For a complete list, see the [Kroki installation docs](htt Supported diagram types include: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - [Bytefield](https://bytefield-svg.deepsymmetry.org/bytefield-svg/intro.html) - [D2](https://d2lang.com/tour/intro/) @@ -64,7 +64,7 @@ Supported diagram types include: - [Vega-Lite](https://github.com/vega/vega-lite) - [WaveDrom](https://wavedrom.com/) -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> If you want to use additional diagram libraries, read the [Kroki installation](https://docs.kroki.io/kroki/setup/install/#_images) to learn how to start Kroki companion containers. @@ -172,11 +172,11 @@ Rel(banking_system, mainframe, "Uses")  -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> **Nomnoml** -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ```plaintext [nomnoml] diff --git a/doc/administration/logs/index.md b/doc/administration/logs/index.md index 25ef240686a565effd7b2e155a917fc61b090c0c..5038970e72e2b479229841eedff7d7f50e5145d8 100644 --- a/doc/administration/logs/index.md +++ b/doc/administration/logs/index.md @@ -1157,13 +1157,13 @@ For Linux package installations, Redis logs are in `/var/log/gitlab/redis/curren For Linux package installations, Alertmanager logs are in `/var/log/gitlab/alertmanager/current`. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> ## crond logs For Linux package installations, crond logs are in `/var/log/gitlab/crond/`. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## Grafana logs diff --git a/doc/administration/logs/tracing_correlation_id.md b/doc/administration/logs/tracing_correlation_id.md index cec737cee4eccdde3327abf14a76a5979a15ccb7..25bc3f74aefb94b872be697f4728eff0e57c35b4 100644 --- a/doc/administration/logs/tracing_correlation_id.md +++ b/doc/administration/logs/tracing_correlation_id.md @@ -195,11 +195,11 @@ You can then view the database details for this request:  - <!-- vale gitlab.Substitutions = NO --> + <!-- vale gitlab_base.Substitutions = NO --> 1. Select the `pg` link in the Progress Bar to view the database queries executed by the API request:  - <!-- vale gitlab.Substitutions = YES --> + <!-- vale gitlab_base.Substitutions = YES --> The database query dialog is displayed: diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index e4c039d9bcfc16e60f4464641808eafe5a4b190e..96fced732069feda5ac2d4f94ec8e99639daa3a3 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/index.md @@ -35,7 +35,7 @@ The package registry supports the following formats: The below table lists formats that are not supported, but are accepting Community contributions for. Consider contributing to GitLab. This [development documentation](../../development/packages/index.md) guides you through the process. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> | Format | Status | | ------ | ------ | @@ -53,7 +53,7 @@ guides you through the process. | Terraform | [Draft: Merge request](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18834) | | Vagrant | [#36899](https://gitlab.com/gitlab-org/gitlab/-/issues/36899) | -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## Rate limits diff --git a/doc/administration/raketasks/check.md b/doc/administration/raketasks/check.md index b0d8215d05ec6615a29f0538a57587c4c5cbcec4..06f7e43fdf2f543e44ee3c508025321fa1183c64 100644 --- a/doc/administration/raketasks/check.md +++ b/doc/administration/raketasks/check.md @@ -267,7 +267,7 @@ decrypted, you can pass a `VERBOSE` environment variable: **Example verbose output** -<!-- vale gitlab.SentenceSpacing = NO --> +<!-- vale gitlab_base.SentenceSpacing = NO --> ```plaintext I, [2020-06-11T17:17:54.951815 #27148] INFO -- : Checking encrypted values in the database @@ -283,7 +283,7 @@ I, [2020-06-11T17:18:15.575678 #27148] INFO -- : Total: 1 row(s) affected I, [2020-06-11T17:18:15.575711 #27148] INFO -- : Done! ``` -<!-- vale gitlab.SentenceSpacing = YES --> +<!-- vale gitlab_base.SentenceSpacing = YES --> ## Reset encrypted tokens when they can't be recovered diff --git a/doc/administration/troubleshooting/postgresql.md b/doc/administration/troubleshooting/postgresql.md index 30776dbb211f93e120b25ca20ba9b17fb3b80bdd..13f64e4e3b51a1d5309906ecdf08080db29b4645 100644 --- a/doc/administration/troubleshooting/postgresql.md +++ b/doc/administration/troubleshooting/postgresql.md @@ -130,11 +130,11 @@ idle_in_transaction_session_timeout = 60s Quoting from issue [#30528](https://gitlab.com/gitlab-org/gitlab/-/issues/30528): -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> > "If a deadlock is hit, and we resolve it through aborting the transaction after a short period, then the retry mechanisms we already have will make the deadlocked piece of work try again, and it's unlikely we'll deadlock multiple times in a row." -<!-- vale gitlab.FutureTense = YES --> +<!-- vale gitlab_base.FutureTense = YES --> NOTE: In Support, our general approach to reconfiguring timeouts (applies also to the diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index 750b30c5eb55fcb52a1e7c7448ec34c0612684b3..b6d955baac022b9312004a01b535f745faf44587 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -14,7 +14,7 @@ DETAILS: [Badges](../user/project/badges.md) support placeholders that are replaced in real time in both the link and image URL. The allowed placeholders are: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - **%{project_path}**: replaced by the project path. - **%{project_title}**: replaced by the project title. @@ -28,7 +28,7 @@ DETAILS: - **%{commit_sha}**: replaced by the project's last commit SHA. - **%{latest_tag}**: replaced by the project's last tag. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> Because these endpoints aren't inside a project's context, the information used to replace the placeholders comes from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders is returned. diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 77061c4c9e945c8e763c4149815de5ba8c35de3e..1552d65c1c1868d02d08109868cf93c15b8122f5 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -14,7 +14,7 @@ DETAILS: [Badges](../user/project/badges.md) support placeholders that are replaced in real-time in both the link and image URL. The allowed placeholders are: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - **%{project_path}**: Replaced by the project path. - **%{project_title}**: Replaced by the project title. @@ -28,7 +28,7 @@ DETAILS: - **%{commit_sha}**: Replaced by the project's last commit SHA. - **%{latest_tag}**: Replaced by the project's last tag. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## List all badges of a project diff --git a/doc/ci/testing/code_coverage.md b/doc/ci/testing/code_coverage.md index 352a2c7fffe53fe3400ca9dc587acccb7d97c313..7351dae0d70c2f9248efb088ed892d462f076920 100644 --- a/doc/ci/testing/code_coverage.md +++ b/doc/ci/testing/code_coverage.md @@ -54,7 +54,7 @@ If the tooling has changed after these samples were created, or if the tooling w the regex might not work. Test the regex carefully to make sure it correctly finds the coverage in the tool's output: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> <!-- markdownlint-disable MD056 --> | Name | Language | Command | Example | @@ -77,7 +77,7 @@ coverage in the tool's output: | tarpaulin | Rust | None | `/^\d+.\d+% coverage/` | | Pester | PowerShell | None | `/Covered (\d+\.\d+%)/` | -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> <!-- markdownlint-enable MD056 --> ### View history of project code coverage diff --git a/doc/ci/yaml/script.md b/doc/ci/yaml/script.md index 09f206af1a056c146556db9f83d04b17f3dd169b..1211367e1286f3173ae5c0f48fdd8836dab51051 100644 --- a/doc/ci/yaml/script.md +++ b/doc/ci/yaml/script.md @@ -200,13 +200,13 @@ Second command line. When you omit the `>` or `|` block scalar indicators, GitLab concatenates non-empty lines to form the command. Make sure the lines can run when concatenated. -<!-- vale gitlab.MeaningfulLinkWords = NO --> +<!-- vale gitlab_base.MeaningfulLinkWords = NO --> [Shell here documents](https://en.wikipedia.org/wiki/Here_document) work with the `|` and `>` operators as well. The example below transliterates lower case letters to upper case: -<!-- vale gitlab.MeaningfulLinkWords = YES --> +<!-- vale gitlab_base.MeaningfulLinkWords = YES --> ```yaml job: @@ -463,8 +463,6 @@ script: This fails as the indentation causes the line breaks to be preserved: -<!-- vale gitlab.CurlStringsQuoted = NO --> - ```plaintext $ RESULT=$(curl --silent # collapsed multi-line command curl: no URL specified! @@ -473,8 +471,6 @@ curl: try 'curl --help' or 'curl --manual' for more information /bin/bash: line 150: https://gitlab.example.com/api/v4/job: No such file or directory ``` -<!-- vale gitlab.CurlStringsQuoted = YES --> - Resolve this by either: - Removing the extra indentation: diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 770d7d74921e002b0ef7e117cc265cead3f111b6..e6bb18735d4643e3276607b053d2b6413cc87895 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -24,13 +24,13 @@ possible. ## How GitLab implements GraphQL -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> We use the [GraphQL Ruby gem](https://graphql-ruby.org/) written by [Robert Mosolgo](https://github.com/rmosolgo/). In addition, we have a subscription to [GraphQL Pro](https://graphql.pro/). For details see [GraphQL Pro subscription](graphql_guide/graphql_pro.md). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> All GraphQL queries are directed to a single endpoint ([`app/controllers/graphql_controller.rb#execute`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app%2Fcontrollers%2Fgraphql_controller.rb)), diff --git a/doc/development/chaos_endpoints.md b/doc/development/chaos_endpoints.md index 0a11e76e8d9696078923172fcf14b43a5989aa75..a23090f1e7cea6d3e54d8f356f9c01dfc48d6334 100644 --- a/doc/development/chaos_endpoints.md +++ b/doc/development/chaos_endpoints.md @@ -6,11 +6,11 @@ info: Any user with at least the Maintainer role can merge updates to this conte # Generating chaos in a test GitLab instance -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> As [Werner Vogels](https://twitter.com/Werner), the CTO at Amazon Web Services, famously put it, **Everything fails, all the time**. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> As a developer, it's as important to consider the failure modes in which your software may operate as much as typical operation. Doing so can mean the difference between a minor hiccup leading to a scattering of `500` errors experienced by a tiny fraction of users, and a full site outage that affects all users for an extended period. diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index e560920cca15dfe8a6d8efa5131b495055b254ca..c49ef87218c5da5f573cdd202f4fb5d04691f1c3 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -158,11 +158,11 @@ See the dedicated [Shell scripting standards and style guidelines](../shell_scri ## Markdown -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> We're following [Ciro Santilli's Markdown Style Guide](https://cirosantilli.com/markdown-style-guide/). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## Documentation diff --git a/doc/development/database/clickhouse/tiered_storage.md b/doc/development/database/clickhouse/tiered_storage.md index e9bb5b80fa49266ab5c6d4531d61430cfbeff19a..711cb5f281c3edf76102edbcf0fef5bf9bf150ae 100644 --- a/doc/development/database/clickhouse/tiered_storage.md +++ b/doc/development/database/clickhouse/tiered_storage.md @@ -13,14 +13,14 @@ for details on setup and further explanation. Quoting from the [MergeTree documentation](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-multiple-volumes): -<!-- vale gitlab.Simplicity = NO --> +<!-- vale gitlab_base.Simplicity = NO --> > MergeTree family table engines can store data on multiple block devices. For example, > it can be useful when the data of a certain table are implicitly split into "hot" and "cold". > The most recent data is regularly requested but requires only a small amount of space. > On the contrary, the fat-tailed historical data is requested rarely. -<!-- vale gitlab.Simplicity = YES --> +<!-- vale gitlab_base.Simplicity = YES --> When used with remote storage backends such as [Amazon S3](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family/mergetree#table_engine-mergetree-s3), diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index a40e7caf45d6d09e0b6149f7eabe52575f31a69a..b0ee975acaa95cc1179bfcfeffe400d75332c002 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -301,7 +301,7 @@ especially in tutorials, instructional documentation, and Some contractions, however, should be avoided: -<!-- vale gitlab.Possessive = NO --> +<!-- vale gitlab_base.Possessive = NO --> | Do not use a contraction | Example | Use instead | |-------------------------------|--------------------------------------------------|------------------------------------------------------------------| @@ -310,7 +310,7 @@ Some contractions, however, should be avoided: | In reference documentation | **Don't** set a limit. | **Do not** set a limit. | | In error messages | Requests to localhost **aren't** allowed. | Requests to localhost **are not** allowed. | -<!-- vale gitlab.Possessive = YES --> +<!-- vale gitlab_base.Possessive = YES --> ### Possessives @@ -382,11 +382,11 @@ when published. Example: ### Emphasis -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> Use **bold** rather than italic to provide emphasis. GitLab uses a sans-serif font and italic text does not stand out as much as it would in a serif font. For details, see [Butterick's Practical Typography guide on bold or italic](https://practicaltypography.com/bold-or-italic.html). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> You can use italics when you are introducing a term for the first time. Otherwise, use bold. @@ -398,12 +398,12 @@ You can use italics when you are introducing a term for the first time. Otherwis Follow these guidelines for punctuation. -<!-- vale gitlab.Repetition = NO --> +<!-- vale gitlab_base.Repetition = NO --> - End full sentences with a period, including full sentences in tables. - Use serial (Oxford) commas before the final **and** or **or** in a list of three or more items. (Tested in [`OxfordComma.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/OxfordComma.yml).) -<!-- vale gitlab.Repetition = YES --> +<!-- vale gitlab_base.Repetition = YES --> When spacing content: @@ -411,7 +411,7 @@ When spacing content: - Do not use non-breaking spaces. Use standard spaces instead. (Tested in [`lint-doc.sh`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/scripts/lint-doc.sh).) - Do not use tabs for indentation. Use spaces instead. You can configure your code editor to output spaces instead of tabs when pressing the <kbd>Tab</kbd> key. -<!-- vale gitlab.NonStandardQuotes = NO --> +<!-- vale gitlab_base.NonStandardQuotes = NO --> Do not use these punctuation characters: @@ -419,7 +419,7 @@ Do not use these punctuation characters: - `–` (en dash) or `—` (em dash): Use separate sentences, or commas, instead. - `“` `â€` `‘` `’`: Double or single typographer's ("curly") quotation marks. Use straight quotes instead. (Tested in [`NonStandardQuotes.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/NonStandardQuotes.yml).) -<!-- vale gitlab.NonStandardQuotes = YES --> +<!-- vale gitlab_base.NonStandardQuotes = YES --> ### Placeholder text diff --git a/doc/development/documentation/testing/index.md b/doc/development/documentation/testing/index.md index e1bab525d00a772dfa5ff7eae7bcb5dad55eb0ff..0d09286631fdafa79c776ea81bb7b7a7f4d1d68e 100644 --- a/doc/development/documentation/testing/index.md +++ b/doc/development/documentation/testing/index.md @@ -217,8 +217,18 @@ synchronized to the other projects. In each of the [supported projects](#support ```shell # Copy markdownlint configuration file cp ../gitlab/.markdownlint-cli2.yaml . - # Copy Vale configuration files for a project with documentation stored in 'docs' directory - cp -r ../gitlab/doc/.vale docs + # Remove existing Vale configuration in case some rules have been removed from the GitLab project + rm -r docs/.vale/gitlab + # Copy gitlab_base Vale configuration files for a project with documentation stored in 'docs' directory + cp -r ../gitlab/doc/.vale/gitlab_base docs/.vale + ``` + +1. If updating `gitlab-runner`, `gitlab-omnibus`, `charts/gitlab`, or `gitlab-operator`, also copy the `gitlab-docs` + Vale configuration from the `gitlab` project. For example, in the root directory of the project, run: + + ```shell + # Copy gitlab-docs Vale configuration files for a project with documentation stored in 'docs' directory + cp -r ../gitlab/doc/.vale/gitlab_docs docs/.vale ``` 1. Review the diff created for `.markdownlint-cli2.yaml`. For example, run: diff --git a/doc/development/documentation/testing/vale.md b/doc/development/documentation/testing/vale.md index 66fb4e682d9b1d8e439a0f10c3d5f3250c9b3142..555c0b5a7e07dd945ce4768f50ebde9a45b9429f 100644 --- a/doc/development/documentation/testing/vale.md +++ b/doc/development/documentation/testing/vale.md @@ -174,10 +174,9 @@ vale --no-wrap --filter='.Name=="gitlab.OutdatedVersions"' doc/**/*.md You can disable a specific Vale linting rule or all Vale linting rules for any portion of a document: -- To disable a specific rule, add a `<!-- vale gitlab.rulename = NO -->` tag before the text, and a - `<!-- vale gitlab.rulename = YES -->` tag after the text, replacing `rulename` with the filename of a test in the - [GitLab styles](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.linting/vale/styles/gitlab) - directory. +- To disable a specific rule, add a `<!-- vale gitlab_<type>.rulename = NO -->` tag before the text, and a + `<!-- vale gitlab_<type>.rulename = YES -->` tag after the text, replacing `rulename` with the filename of a test in the + directory of one of the [GitLab styles](https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/.vale). - To disable all Vale linting rules, add a `<!-- vale off -->` tag before the text, and a `<!-- vale on -->` tag after the text. diff --git a/doc/development/fe_guide/graphql.md b/doc/development/fe_guide/graphql.md index 8094b053d6ce6933ac3433c73497a14bacc6e568..4b8a0954a4243f506de4754a70810bf44ce6837a 100644 --- a/doc/development/fe_guide/graphql.md +++ b/doc/development/fe_guide/graphql.md @@ -17,7 +17,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte **GraphQL at GitLab**: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [GitLab Unfiltered GraphQL playlist](https://www.youtube.com/watch?v=wHPKZBDMfxE&list=PL05JrBw4t0KpcjeHjaRMB7IGB2oDWyJzv) - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [GraphQL at GitLab: Deep Dive](../api_graphql_styleguide.md#deep-dive) (video) by Nick Thomas @@ -30,7 +30,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte - [🛠Vuex -> Apollo Migration: a proof-of-concept project](https://gitlab.com/ntepluhina/vuex-to-apollo/blob/master/README.md) - A collection of examples that show the possible approaches for state management with Vue+GraphQL+(Vuex or Apollo) apps -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Libraries @@ -47,11 +47,11 @@ see [Immutability and cache updates](#immutability-and-cache-updates) for more i ### Tooling -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - [Apollo Client Devtools](https://github.com/apollographql/apollo-client-devtools) -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> #### Apollo GraphQL VS Code extension diff --git a/doc/development/fe_guide/index.md b/doc/development/fe_guide/index.md index 74218f5106dd6b7264def2a075976836d5b28bc2..e0a0cf594c3b459253b2eb5294f12335880ac7b8 100644 --- a/doc/development/fe_guide/index.md +++ b/doc/development/fe_guide/index.md @@ -13,11 +13,11 @@ across the GitLab frontend team. GitLab is built on top of [Ruby on Rails](https://rubyonrails.org). It uses [Haml](https://haml.info/) and a JavaScript-based frontend with [Vue.js](https://vuejs.org). If you are not sure when to use Vue on top of Haml-page, read [this explanation](vue.md#when-to-add-vue-application). -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> Be wary of [the limitations that come with using Hamlit](https://github.com/k0kubun/hamlit/blob/master/REFERENCE.md#limitations). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> When it comes to CSS, we use a utils-based CSS approach. GitLab has its own CSS utils which are packaged inside the `gitlab-ui` project and can be seen [in the repository](https://gitlab.com/gitlab-org/gitlab-ui/-/tree/main/src/scss/utility-mixins) or on [UNPKG](https://unpkg.com/browse/@gitlab/ui@latest/src/scss/utility-mixins/). Favor using these before adding or using any SCSS classes. diff --git a/doc/development/fe_guide/performance.md b/doc/development/fe_guide/performance.md index c62821d09fe0be472e08b582894829b206210cf7..902416b239976aa86fc57db1e806dfa580237103 100644 --- a/doc/development/fe_guide/performance.md +++ b/doc/development/fe_guide/performance.md @@ -227,7 +227,7 @@ When writing code for real-time features we have to keep a couple of things in m Thus, we must strike a balance between sending requests and the feeling of real-time. Use the following rules when creating real-time solutions. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> 1. The server tells you how much to poll by sending `Poll-Interval` in the header. Use that as your polling interval. This enables system administrators to change the @@ -241,7 +241,7 @@ Use the following rules when creating real-time solutions. 1. The backend code is likely to be using ETags. You do not and should not check for status `304 Not Modified`. The browser transforms it for you. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Lazy Loading Images diff --git a/doc/development/gitaly.md b/doc/development/gitaly.md index 138a6f794e1434077a579c7411cdd3dfc9f81038..3d7ce2c7ae6fbc89bf678a66149cc7d6950f5db1 100644 --- a/doc/development/gitaly.md +++ b/doc/development/gitaly.md @@ -11,7 +11,7 @@ Workhorse and GitLab Shell. ## Deep Dive -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> In May 2019, Bob Van Landuyt hosted a Deep Dive (GitLab team members only: `https://gitlab.com/gitlab-org/create-stage/-/issues/1`) @@ -19,7 +19,7 @@ on the [Gitaly project](https://gitlab.com/gitlab-org/gitaly). It included how t Ruby developer, and shared domain-specific knowledge with anyone who may work in this part of the codebase in the future. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> You can find the <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [recording on YouTube](https://www.youtube.com/watch?v=BmlEWFS8ORo), and the slides on [Google Slides](https://docs.google.com/presentation/d/1VgRbiYih9ODhcPnL8dS0W98EwFYpJ7GXMPpX-1TM6YE/edit) diff --git a/doc/development/gitlab_flavored_markdown/index.md b/doc/development/gitlab_flavored_markdown/index.md index 5f99192f51f480ed05b47ccd5f167b20445b2b1c..6a2abe0b6a8e696aa6c30626d2de093759c71890 100644 --- a/doc/development/gitlab_flavored_markdown/index.md +++ b/doc/development/gitlab_flavored_markdown/index.md @@ -5,7 +5,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte description: "Development guidelines for GitLab Flavored Markdown (GLFM)." --- -<!-- vale gitlab.GitLabFlavoredMarkdown = NO --> +<!-- vale gitlab_base.GitLabFlavoredMarkdown = NO --> # GitLab Flavored Markdown (GLFM) development guidelines diff --git a/doc/development/gitlab_flavored_markdown/specification_guide/index.md b/doc/development/gitlab_flavored_markdown/specification_guide/index.md index 272b3174f1a1e72e3eb9c222ddf5d45b37f6223b..f6ba217c43565a6982bef82acebf77fdc7b7dc5e 100644 --- a/doc/development/gitlab_flavored_markdown/specification_guide/index.md +++ b/doc/development/gitlab_flavored_markdown/specification_guide/index.md @@ -5,7 +5,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte description: "Specification guide for GitLab Flavored Markdown (GLFM)." --- -<!-- vale gitlab.GitLabFlavoredMarkdown = NO --> +<!-- vale gitlab_base.GitLabFlavoredMarkdown = NO --> # GitLab Flavored Markdown (GLFM) Specification Guide @@ -252,7 +252,7 @@ because of this comprehensive style. Regarding the terminology used for Markdown snapshot testing: -<!-- vale gitlab.InclusiveLanguage = NO --> +<!-- vale gitlab_base.InclusiveLanguage = NO --> 1. The Markdown snapshot tests can be considered a form of the [Golden Master Testing approach](https://www.google.com/search?q=golden+master+testing), @@ -286,7 +286,7 @@ Regarding the terminology used for Markdown snapshot testing: it simpler and more understandable to have everything under the `glfm_specification` directory rather than splitting these files into the `spec/fixtures` directory. -<!-- vale gitlab.InclusiveLanguage = YES --> +<!-- vale gitlab_base.InclusiveLanguage = YES --> See also the section on [normalization](#normalization) below, which is an important concept used in the Markdown snapshot testing. diff --git a/doc/development/i18n/proofreader.md b/doc/development/i18n/proofreader.md index 1b9fa1553e990f479902a65c36bfb0a2d067b57c..9082c130156711b99ee1a4a5fe11ffabb13093b2 100644 --- a/doc/development/i18n/proofreader.md +++ b/doc/development/i18n/proofreader.md @@ -11,7 +11,7 @@ are very appreciative of the work done by translators and proofreaders! ## Proofreaders -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - Albanian - Proofreaders needed. @@ -112,7 +112,7 @@ are very appreciative of the work done by translators and proofreaders! - Andrew Vityuk - [GitLab](https://gitlab.com/3_1_3_u), [Crowdin](https://crowdin.com/profile/andruwa13) - Welsh - Proofreaders needed. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## Become a proofreader diff --git a/doc/development/i18n/translation.md b/doc/development/i18n/translation.md index cf12a75e355288a43cf20ece313dbf122a5d0732..79f48be788e415e50ea29da694397266247c72dc 100644 --- a/doc/development/i18n/translation.md +++ b/doc/development/i18n/translation.md @@ -87,12 +87,12 @@ are GitLab values. We ask you to avoid translations that exclude people based on ethnicity. In languages that distinguish between a male and female form, use both or choose a neutral formulation. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> For example, in German, the word _user_ can be translated into _Benutzer_ (male) or _Benutzerin_ (female). Therefore, _create a new user_ translates to _Benutzer(in) anlegen_. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Updating the glossary @@ -101,10 +101,10 @@ To propose additions to the glossary, ## French translation guidelines -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> In French, the _écriture inclusive_ is now over (see on [Legifrance](https://www.legifrance.gouv.fr/jorf/id/JORFTEXT000036068906/)). To include both genders, write _Utilisateurs et utilisatrices_ instead of _Utilisateur·rice·s_. If there is not enough space, use the male gender alone. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> diff --git a/doc/development/integrations/jira_connect.md b/doc/development/integrations/jira_connect.md index 22560ce00db39d57f36777b2710b65596ef2cc7a..d43d6d9a231872a965150a6d01b25a8f413dcfa7 100644 --- a/doc/development/integrations/jira_connect.md +++ b/doc/development/integrations/jira_connect.md @@ -26,12 +26,12 @@ The following are required to install the app: - [GDK in Gitpod](https://www.loom.com/share/9c9711d4876a40869b9294eecb24c54d) video. - <!-- vale gitlab.Spelling = NO --> + <!-- vale gitlab_base.Spelling = NO --> GitLab team members **must not** use tunneling tools such as Serveo or `ngrok`. These are security risks, and must not be run on GitLab developer laptops. - <!-- vale gitlab.Spelling = YES --> + <!-- vale gitlab_base.Spelling = YES --> Jira requires all connections to the app host to be over SSL. If you set up your own environment, remember to enable SSL and an appropriate certificate. diff --git a/doc/development/merge_request_concepts/diffs/index.md b/doc/development/merge_request_concepts/diffs/index.md index 5f22f24ed1ef974b62a1dfb6639768cfa9e544e7..2d2a379a911fdffca8eccb9f1576346202fd8771 100644 --- a/doc/development/merge_request_concepts/diffs/index.md +++ b/doc/development/merge_request_concepts/diffs/index.md @@ -18,14 +18,14 @@ We rely on different sources to present diffs. These include: ## Deep Dive -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> In January 2019, Oswaldo Ferreira hosted a Deep Dive (GitLab team members only: `https://gitlab.com/gitlab-org/create-stage/-/issues/1`) on GitLab Diffs and Commenting on Diffs functionality to share domain-specific knowledge with anyone who works in this part of the codebase in the future: -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> - <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [Recording on YouTube](https://www.youtube.com/watch?v=K6G3gMcFyek) diff --git a/doc/development/pipelines/internals.md b/doc/development/pipelines/internals.md index dc828060ecfb1b82095fd1f05ef2a55f78303bed..59a1899c03b88366dc5e798086d85366ded86e1b 100644 --- a/doc/development/pipelines/internals.md +++ b/doc/development/pipelines/internals.md @@ -70,11 +70,11 @@ purposes. The default image is defined in [`.gitlab-ci.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab-ci.yml). -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> It includes Ruby, Go, Git, Git LFS, Chrome, Node, Yarn, PostgreSQL, and Graphics Magick. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> The images used in our pipelines are configured in the [`gitlab-org/gitlab-build-images`](https://gitlab.com/gitlab-org/gitlab-build-images) @@ -202,7 +202,7 @@ and included in `rules` definitions via [YAML anchors](../../ci/yaml/yaml_optimi ### `if:` conditions -<!-- vale gitlab.Substitutions = NO --> +<!-- vale gitlab_base.Substitutions = NO --> | `if:` conditions | Description | Notes | |------------------|-------------|-------| @@ -229,7 +229,7 @@ and included in `rules` definitions via [YAML anchors](../../ci/yaml/yaml_optimi | `if-dot-com-gitlab-org-merge-request` | Limits jobs creation to merge requests for the `gitlab-org` group on GitLab.com. | | | `if-dot-com-ee-schedule` | Limits jobs to scheduled pipelines for the `gitlab-org/gitlab` project on GitLab.com. | | -<!-- vale gitlab.Substitutions = YES --> +<!-- vale gitlab_base.Substitutions = YES --> ### `changes:` patterns diff --git a/doc/development/profiling.md b/doc/development/profiling.md index a7a5f993ca9a9e0f160fa65bdebe0e3e22410298..bfc5a9ae6937a89e36e367c09bd0c2e7f6b0e946 100644 --- a/doc/development/profiling.md +++ b/doc/development/profiling.md @@ -131,7 +131,7 @@ Find more information about different sampling modes in the [Stackprof docs](htt This is enabled for all users that can access the performance bar. -<!-- vale gitlab.SubstitutionWarning = NO --> +<!-- vale gitlab_base.SubstitutionWarning = NO --> <!-- Here, "bullet" is a false positive --> ## Bullet @@ -163,7 +163,7 @@ because Bullet logging is noisy. To configure Bullet and its logging: As a follow-up to finding `N+1` queries with Bullet, consider writing a [QueryRecoder test](database/query_recorder.md) to prevent a regression. -<!-- vale gitlab.SubstitutionWarning = YES --> +<!-- vale gitlab_base.SubstitutionWarning = YES --> ## System stats diff --git a/doc/development/projections.md b/doc/development/projections.md index a9a06d91d2c1ee87b950066639b4c367778fc94d..6a4b73854c2f53a0e52921bf607b01a52ac1b194 100644 --- a/doc/development/projections.md +++ b/doc/development/projections.md @@ -33,10 +33,10 @@ You can find a basic list of projection options in ## History -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> This started as a [plugin for vim by tpope](https://github.com/tpope/vim-projectionist) It has since become editor-agnostic and ported to most modern editors. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> diff --git a/doc/development/redis.md b/doc/development/redis.md index ab4307ccf2611b33230a22c774da09319ccb6285..ad6910eae511d70d742dac8156824febb2f95ea8 100644 --- a/doc/development/redis.md +++ b/doc/development/redis.md @@ -127,14 +127,14 @@ NOTE: There is a [video showing how to see the slow log](https://youtu.be/BBI68QuYRH8) (GitLab internal) on GitLab.com -<!-- vale gitlab.Substitutions = NO --> +<!-- vale gitlab_base.Substitutions = NO --> On GitLab.com, entries from the [Redis slow log](https://redis.io/docs/latest/commands/slowlog/) are available in the `pubsub-redis-inf-gprd*` index with the [`redis.slowlog` tag](https://log.gprd.gitlab.net/app/kibana#/discover?_g=(filters:!(),refreshInterval:(pause:!t,value:0),time:(from:now-1d,to:now))&_a=(columns:!(json.type,json.command,json.exec_time_s),filters:!(('$state':(store:appState),meta:(alias:!n,disabled:!f,index:AWSQX_Vf93rHTYrsexmk,key:json.tag,negate:!f,params:(query:redis.slowlog),type:phrase),query:(match:(json.tag:(query:redis.slowlog,type:phrase))))),index:AWSQX_Vf93rHTYrsexmk)). This shows commands that have taken a long time and may be a performance concern. -<!-- vale gitlab.Substitutions = YES --> +<!-- vale gitlab_base.Substitutions = YES --> The [`fluent-plugin-redis-slowlog`](https://gitlab.com/gitlab-org/ruby/gems/fluent-plugin-redis-slowlog) diff --git a/doc/development/repository_mirroring.md b/doc/development/repository_mirroring.md index bf49f8982c3c8112e76b5b7ebb56ec7eeab87702..ee441b6ef8a5a3258a1a04bf5f3b4687067b5630 100644 --- a/doc/development/repository_mirroring.md +++ b/doc/development/repository_mirroring.md @@ -8,7 +8,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte ## Deep Dive -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> In December 2018, Tiago Botelho hosted a Deep Dive (GitLab team members only: `https://gitlab.com/gitlab-org/create-stage/-/issues/1`) on the GitLab [Pull Repository Mirroring functionality](../user/project/repository/mirror/pull.md) @@ -17,7 +17,7 @@ codebase in the future. You can find the <i class="fa fa-youtube-play youtube" a and the slides in [PDF](https://gitlab.com/gitlab-org/create-stage/uploads/8693404888a941fd851f8a8ecdec9675/Gitlab_Create_-_Pull_Mirroring_Deep_Dive.pdf). Specific details may have changed since then, but it should still serve as a good introduction. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ## Explanation of mirroring process diff --git a/doc/development/spam_protection_and_captcha/exploratory_testing.md b/doc/development/spam_protection_and_captcha/exploratory_testing.md index 63315d762397b4856ea9026ae731c0487af30d0a..da6696c23cbafa38eef1b0d62e6d3111eb57bc58 100644 --- a/doc/development/spam_protection_and_captcha/exploratory_testing.md +++ b/doc/development/spam_protection_and_captcha/exploratory_testing.md @@ -74,11 +74,11 @@ If CAPTCHA is enabled in these areas, you must solve the CAPTCHA popup modal bef - **Admin -> Settings -> Reporting -> Spam** - **Anti-bot Protection -> Enable reCAPTCHA** -<!-- vale gitlab.Substitutions = NO --> +<!-- vale gitlab_base.Substitutions = NO --> ### Testing with CAPTCHA disabled ("DISALLOW" verdict) -<!-- vale gitlab.Substitutions = YES --> +<!-- vale gitlab_base.Substitutions = YES --> If CAPTCHA is disabled in **Admin -> Settings -> Reporting -> Spam** and **Anti-bot Protection -> Enable reCAPTCHA**, no CAPTCHA popup displays. You are prevented from submitting the form at all. diff --git a/doc/development/testing_guide/best_practices.md b/doc/development/testing_guide/best_practices.md index c69b24ba3512795028bb0e804fa6d026d750186d..b1a02a7437880d1c48fce3d34b321d2f4fb50db9 100644 --- a/doc/development/testing_guide/best_practices.md +++ b/doc/development/testing_guide/best_practices.md @@ -1468,14 +1468,14 @@ NoMethodError: That indicates that you need to include the line `using RSpec::Parameterized::TableSyntax` in the spec file. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> WARNING: Only use simple values as input in the `where` block. Using procs, stateful objects, FactoryBot-created objects, and similar items can lead to [unexpected results](https://github.com/tomykaira/rspec-parameterized/issues/8). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Prometheus tests diff --git a/doc/development/testing_guide/frontend_testing.md b/doc/development/testing_guide/frontend_testing.md index 56105b736f2bef6596458461389ba399235258a4..b845f3b70c983cc411df023f1578a392e6a3636f 100644 --- a/doc/development/testing_guide/frontend_testing.md +++ b/doc/development/testing_guide/frontend_testing.md @@ -1205,12 +1205,12 @@ testAction( ### Wait until Axios requests finish -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> The Axios Utils mock module located in `spec/frontend/__helpers__/mocks/axios_utils.js` contains two helper methods for Jest tests that spawn HTTP requests. These are very useful if you don't have a handle to the request's Promise, for example when a Vue component does a request as part of its life cycle. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> - `waitFor(url, callback)`: Runs `callback` after a request to `url` finishes (either successfully or unsuccessfully). - `waitForAll(callback)`: Runs `callback` once all pending requests have finished. If no requests are pending, runs `callback` on the next tick. diff --git a/doc/install/azure/index.md b/doc/install/azure/index.md index 7eea9ec999312715e94b4dc46e0d5b4825b5b2e7..9f7375929393e863dbf3bb15119a010675b4bed1 100644 --- a/doc/install/azure/index.md +++ b/doc/install/azure/index.md @@ -315,15 +315,11 @@ a GPG key [deprecated in April 2020](https://about.gitlab.com/blog/2020/03/30/gp If you try to update the repositories, the system returns the following error: -<!-- vale gitlab.ReferenceLinks = NO --> - ```plaintext [ 21.023494] apt-setup[1198]: W: GPG error: https://packages.gitlab.com/gitlab/gitlab-ee/debian buster InRelease: The following signatures couldn't be verified because the public key is not available: NO_PUBKEY 3F01618A51312F3F [ 21.024033] apt-setup[1198]: E: The repository 'https://packages.gitlab.com/gitlab/gitlab-ee/debian buster InRelease' is not signed. ``` -<!-- vale gitlab.ReferenceLinks = YES --> - To fix this, fetch the new GPG key: ```shell diff --git a/doc/integration/datadog.md b/doc/integration/datadog.md index 39255f8916499a9f8fc2fa4fef13799d8b318093..63a900cd9a0725cf77e417d5f105278e5728cddc 100644 --- a/doc/integration/datadog.md +++ b/doc/integration/datadog.md @@ -40,11 +40,11 @@ or for a specific project or group: Used only in advanced scenarios. 1. Optional. If you use more than one GitLab instance, provide a unique **Service** name to differentiate between your GitLab instances. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> 1. Optional. If you use groups of GitLab instances (such as staging and production environments), provide an **Env** name. This value is attached to each span the integration generates. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> 1. Optional. To define any custom tags for all spans at which the integration is being configured, enter one tag per line in **Tags**. Each line must be in the format `key:value`. 1. Optional. Select **Test settings**. diff --git a/doc/integration/gmail_action_buttons_for_gitlab.md b/doc/integration/gmail_action_buttons_for_gitlab.md index c4f04ee3edccf2eb78ce62cab98127584ac02d7b..88fb747ce1c62dcfc3b3e46a220a063f8a23e0a6 100644 --- a/doc/integration/gmail_action_buttons_for_gitlab.md +++ b/doc/integration/gmail_action_buttons_for_gitlab.md @@ -23,7 +23,7 @@ Google to avoid your application being rejected by Google. In particular, note: -<!-- vale gitlab.InclusiveLanguage = NO --> +<!-- vale gitlab_base.InclusiveLanguage = NO --> - The email account used by GitLab to send notification emails must: - Have a "Consistent history of sending a high volume of mail from your domain @@ -37,6 +37,6 @@ In particular, note: registering. You can also go into the Rails console on the GitLab server and trigger sending the email from there. -<!-- vale gitlab.InclusiveLanguage = YES --> +<!-- vale gitlab_base.InclusiveLanguage = YES --> You can check how it looks going through all the steps laid out in the "Registering with Google" doc in [this GitLab.com issue](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/1517). diff --git a/doc/integration/index.md b/doc/integration/index.md index 2de016bbd55f77bbe8f07cd899e6435564ad4a72..9c96bee864f39b1e71cc34a4224bf4862fcaf76a 100644 --- a/doc/integration/index.md +++ b/doc/integration/index.md @@ -32,7 +32,7 @@ Solutions like Akismet and reCAPTCHA are available for spam protection. You can also integrate GitLab with the following security partners: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - [Anchore](https://docs.anchore.com/current/docs/integration/ci_cd/gitlab/) - [Prisma Cloud](https://docs.prismacloud.io/en/enterprise-edition/content-collections/application-security/get-started/connect-code-and-build-providers/code-repositories/add-gitlab) @@ -49,7 +49,7 @@ You can also integrate GitLab with the following security partners: - [Venafi](https://marketplace.venafi.com/xchange/620d2d6ed419fb06a5c5bd36/solution/6292c2ef7550f2ee553cf223) - [Veracode](https://community.veracode.com/s/knowledgeitem/gitlab-ci-MCEKSYPRWL35BRTGOVI55SK5RI4A) -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> GitLab can check your application for security vulnerabilities. For more information, see [Secure your application](../user/application_security/secure_your_application.md). diff --git a/doc/integration/jira/jira_server_configuration.md b/doc/integration/jira/jira_server_configuration.md index 0ad071d526df438c7e3fec6df87a134e4e14a45d..232fa61ccab71676454ca9f38865049842e2bee6 100644 --- a/doc/integration/jira/jira_server_configuration.md +++ b/doc/integration/jira/jira_server_configuration.md @@ -46,9 +46,9 @@ To create a Jira group for the user: `gitlab-developers`), then select **Add group**. 1. To add the `gitlab` user to the new `gitlab-developers` group, select **Edit members**. The `gitlab-developers` group appears as a selected group. -<!-- vale gitlab.BadPlurals = NO --> +<!-- vale gitlab_base.BadPlurals = NO --> 1. In the **Add members to selected group(s)** section, enter `gitlab`. -<!-- vale gitlab.BadPlurals = YES --> +<!-- vale gitlab_base.BadPlurals = YES --> 1. Select **Add selected users**. The `gitlab` user appears as a group member. diff --git a/doc/operations/incident_management/alerts.md b/doc/operations/incident_management/alerts.md index fb8f4c8a203a8a5de6c857650504329892f8b724..0bebd503c59a96db6d06be2fa59e6e9c7ef7a101 100644 --- a/doc/operations/incident_management/alerts.md +++ b/doc/operations/incident_management/alerts.md @@ -45,7 +45,7 @@ Each level of alert contains a uniquely shaped and color-coded icon to help you Alerts contain one of the following icons: -<!-- vale gitlab.SubstitutionWarning = NO --> +<!-- vale gitlab_base.SubstitutionWarning = NO --> | Severity | Icon | Color (hexadecimal) | |----------|-------------------------|---------------------| @@ -56,7 +56,7 @@ Alerts contain one of the following icons: | Info | **{severity-info}** | `#418cd8` | | Unknown | **{severity-unknown}** | `#bababa` | -<!-- vale gitlab.SubstitutionWarning = YES --> +<!-- vale gitlab_base.SubstitutionWarning = YES --> ## Alert details page diff --git a/doc/topics/autodevops/stages.md b/doc/topics/autodevops/stages.md index 15617feb382c4f5fe2ed2e70d9af1621123f9c9a..d6fd3d0454b527076da7e10e48c5788424940d8d 100644 --- a/doc/topics/autodevops/stages.md +++ b/doc/topics/autodevops/stages.md @@ -115,7 +115,7 @@ Check the [currently supported languages](#currently-supported-languages). Auto Test uses tests you already have in your application. If there are no tests, it's up to you to add them. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> NOTE: Not all buildpacks supported by [Auto Build](#auto-build) are supported by Auto Test. @@ -123,7 +123,7 @@ Auto Test uses [Herokuish](https://gitlab.com/gitlab-org/gitlab/-/issues/212689) Cloud Native Buildpacks, and only buildpacks that implement the [Testpack API](https://devcenter.heroku.com/articles/testpack-api) are supported. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Currently supported languages diff --git a/doc/topics/plan_and_track.md b/doc/topics/plan_and_track.md index 76ffbdc0223ea1ace02358fbd1e3bd1e5e3c83dd..de10042f649fe5d6a18492e3192a2165800d34df 100644 --- a/doc/topics/plan_and_track.md +++ b/doc/topics/plan_and_track.md @@ -12,7 +12,7 @@ with milestones and track your team's time. Learn how to save time with quick actions, see how GitLab renders Markdown text, and learn how to use Git to interact with GitLab. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> For a thorough demo of Plan features, see @@ -20,7 +20,7 @@ For a thorough demo of Plan features, see In this video, Gabe describes a use case of a multi-team organization that uses GitLab with [Scaled Agile Framework (SAFe)](https://handbook.gitlab.com/handbook/marketing/brand-and-product-marketing/product-and-solution-marketing/demo/executive-demo/#scaled-agile-framework-safe). -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> - [Tutorial: Use GitLab to facilitate scrum](../tutorials/scrum_events/index.md) - [Labels](../user/project/labels.md) diff --git a/doc/tutorials/boards_for_teams/index.md b/doc/tutorials/boards_for_teams/index.md index 32490ba41e892b6db065814caeee0dd47fc5f665..e4b5e087695b47a6f0568e27e9b15536788f973e 100644 --- a/doc/tutorials/boards_for_teams/index.md +++ b/doc/tutorials/boards_for_teams/index.md @@ -10,7 +10,7 @@ DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab.com, Self-managed, GitLab Dedicated -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> This tutorial shows you how to set up [issue boards](../../user/project/issue_board.md) and [scoped labels](../../user/project/labels.md#scoped-labels) for two teams that work on issues in sequence. diff --git a/doc/tutorials/hugo/index.md b/doc/tutorials/hugo/index.md index f736ebeb6a333687f66e79aac793ee5aaa0e9965..c549284afe0e52470264acb7be5006b5fbfd30b1 100644 --- a/doc/tutorials/hugo/index.md +++ b/doc/tutorials/hugo/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Tutorial: Build, test, and deploy your Hugo site with GitLab -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> This tutorial walks you through creating a CI/CD pipeline to build, test, and deploy a Hugo site. diff --git a/doc/tutorials/idea_management/index.md b/doc/tutorials/idea_management/index.md index d7653baadcc75f9bb0fa93ab422d982ce868b830..773a5636c119e3f25b0c4dbdf833922bb4b3c5b5 100644 --- a/doc/tutorials/idea_management/index.md +++ b/doc/tutorials/idea_management/index.md @@ -10,7 +10,7 @@ DETAILS: **Tier:** Free, Premium, Ultimate **Offering:** GitLab.com, Self-managed, GitLab Dedicated -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> Idea management refers to the collection, organization, evaluation, and implementation of ideas within an organization or community. diff --git a/doc/tutorials/issue_triage/index.md b/doc/tutorials/issue_triage/index.md index 14ee6e94d2d2e895814d09dbf26ca7fe99d788da..7d020085af827be509a1d7d6c9d8f2399cc103b3 100644 --- a/doc/tutorials/issue_triage/index.md +++ b/doc/tutorials/issue_triage/index.md @@ -10,7 +10,7 @@ DETAILS: **Tier:** Free, Premium, Ultimate **Offering:** GitLab.com, Self-managed, GitLab Dedicated -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> Issue triage is the process of categorization according to type and severity. As your project grows and people create more issues, it's worth creating a workflow for how you'll diff --git a/doc/tutorials/kanban/index.md b/doc/tutorials/kanban/index.md index c5bea5ee2ceb32110c644d4e0c00b64f216ad7d2..d9971b71e3f9f8af539658dca7649e2baa2f974c 100644 --- a/doc/tutorials/kanban/index.md +++ b/doc/tutorials/kanban/index.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Tutorial: Use GitLab to facilitate Kanban -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> This tutorial guides you through the steps on using GitLab issue boards to manage your tasks in a Kanban workflow. By setting up groups, projects, boards, and organizing issues, you can enhance transparency, collaboration, and delivery. diff --git a/doc/tutorials/observability/observability_django_tutorial.md b/doc/tutorials/observability/observability_django_tutorial.md index bdf5033e1ae24ae52b47a587affb3dcf8959113f..b135e535f25fa62e988f899cc0b69aa6478d1e11 100644 --- a/doc/tutorials/observability/observability_django_tutorial.md +++ b/doc/tutorials/observability/observability_django_tutorial.md @@ -17,7 +17,7 @@ For more information, see the history of the [**Distributed tracing** feature](. In this tutorial, we'll show you how to create, configure, instrument, and monitor a Django application using GitLab observability features. -<!-- vale gitlab.SentenceSpacing = NO --> +<!-- vale gitlab_base.SentenceSpacing = NO --> ## Before you begin @@ -190,4 +190,4 @@ To create an application:  -<!-- vale gitlab.SentenceSpacing = YES --> +<!-- vale gitlab_base.SentenceSpacing = YES --> diff --git a/doc/tutorials/protected_workflow/index.md b/doc/tutorials/protected_workflow/index.md index 81fbbb0e28ab3bf93eb70ebc6d669c38dd58ba43..28db89ad66659391d43a379966c4b36e043a8cc3 100644 --- a/doc/tutorials/protected_workflow/index.md +++ b/doc/tutorials/protected_workflow/index.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated description: "Use this tutorial to build a protected workflow for your GitLab project." --- -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> # Tutorial: Build a protected workflow for your project diff --git a/doc/tutorials/scrum_events/index.md b/doc/tutorials/scrum_events/index.md index 20c237f4bb6121b13852688bf5338f24a601e56c..bb5c1dcc3ffbffd6887041188f999320ff542e3e 100644 --- a/doc/tutorials/scrum_events/index.md +++ b/doc/tutorials/scrum_events/index.md @@ -10,7 +10,7 @@ DETAILS: **Tier:** Premium, Ultimate **Offering:** GitLab.com, Self-managed, GitLab Dedicated -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> This tutorial provides step-by-step guidance on using agile planning and tracking features in GitLab to facilitate core Scrum ceremonies and workflows. diff --git a/doc/tutorials/scrum_events/standups_retrospectives_velocity.md b/doc/tutorials/scrum_events/standups_retrospectives_velocity.md index 22bf7ddea044d15457ee3fa57f32ac2607b9eb46..4acef33c57290d8c5a3f35a40c24383cad84e79b 100644 --- a/doc/tutorials/scrum_events/standups_retrospectives_velocity.md +++ b/doc/tutorials/scrum_events/standups_retrospectives_velocity.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Stand-ups, retrospectives, and velocity -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> In addition to the core Scrum ceremonies such as sprint planning and reviews, teams can use GitLab to facilitate the following common Scrum ceremonies in both co-located and distributed environments: @@ -63,10 +63,10 @@ A retrospective is a blameless opportunity for the team to identify process impr progress. You can choose from many retrospective formats. -<!-- vale gitlab.InclusiveLanguage = NO --> +<!-- vale gitlab_base.InclusiveLanguage = NO --> James Shore provides [an excellent outline for how to conduct a retrospective](https://www.jamesshore.com/v2/books/aoad1/retrospectives) in his book, "The Art of Agile." -<!-- vale gitlab.InclusiveLanguage = YES --> +<!-- vale gitlab_base.InclusiveLanguage = YES --> ### Synchronous retrospectives diff --git a/doc/update/versions/gitlab_14_changes.md b/doc/update/versions/gitlab_14_changes.md index 8ad2f8e250c1ed44cc0757bea284f8f7472daa9f..bb7b08e5a7167ab55ce1c239ae1b446b20963699 100644 --- a/doc/update/versions/gitlab_14_changes.md +++ b/doc/update/versions/gitlab_14_changes.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> <!--- start_remove The following content will be removed on remove_date: '2024-08-30' --> # GitLab 14 changes diff --git a/doc/user/application_security/api_fuzzing/create_har_files.md b/doc/user/application_security/api_fuzzing/create_har_files.md index d22cf640bbde6d7577042d8f3cfc6468e9ad39a8..9d0a956994ab4152c0d39e34f822d24832e761da 100644 --- a/doc/user/application_security/api_fuzzing/create_har_files.md +++ b/doc/user/application_security/api_fuzzing/create_har_files.md @@ -74,9 +74,7 @@ Install GitLab HAR Recorder: To verify the HAR contains all requests, use an online HAR viewer, for example: - [HAR Viewer](http://www.softwareishard.com/har/viewer/) -<!-- vale gitlab.Admin = NO --> - [Google Admin Toolbox HAR Analyzer](https://toolbox.googleapps.com/apps/har_analyzer/) -<!-- vale gitlab.Admin = YES --> ### Insomnia API Client @@ -197,9 +195,7 @@ a text editor. Tools recommended for viewing HAR files include: - [HAR Viewer](http://www.softwareishard.com/har/viewer/) - (online) -<!-- vale gitlab.Admin = NO --> - [Google Admin Toolbox HAR Analyzer](https://toolbox.googleapps.com/apps/har_analyzer/) - (online) -<!-- vale gitlab.Admin = YES --> - [Fiddler](https://www.telerik.com/fiddler) - local - [Insomnia API Client](https://insomnia.rest/) - local diff --git a/doc/user/application_security/coverage_fuzzing/index.md b/doc/user/application_security/coverage_fuzzing/index.md index 9a7f52b0533d7c807652addd64c93a264cbe9f10..6cccec90d2e7cf43c4186c60f41904432271f4ec 100644 --- a/doc/user/application_security/coverage_fuzzing/index.md +++ b/doc/user/application_security/coverage_fuzzing/index.md @@ -344,8 +344,6 @@ which shows an overview of all the security vulnerabilities in your groups, proj Selecting the vulnerability opens a modal that provides additional information about the vulnerability: -<!-- vale gitlab.Acronyms = NO --> - - Status: The vulnerability's status. As with any type of vulnerability, a coverage fuzzing vulnerability can be Detected, Confirmed, Dismissed, or Resolved. - Project: The project in which the vulnerability exists. @@ -360,8 +358,6 @@ vulnerability: - Scanner Provider: The engine that did the scan. For Coverage Fuzzing, this can be any of the engines listed in [Supported fuzzing engines and languages](#supported-fuzzing-engines-and-languages). -<!-- vale gitlab.Acronyms = YES --> - ## Troubleshooting ### Error `Unable to extract corpus folder from artifacts zip file` diff --git a/doc/user/application_security/secret_detection/pipeline/detected_secrets.md b/doc/user/application_security/secret_detection/pipeline/detected_secrets.md index e6a1ef60e04df76f018f229f865b9d9696f00226..b33b664e711d6e5913554b9dd101695fd435119b 100644 --- a/doc/user/application_security/secret_detection/pipeline/detected_secrets.md +++ b/doc/user/application_security/secret_detection/pipeline/detected_secrets.md @@ -16,7 +16,7 @@ This table lists the secrets detected by [pipeline secret detection](index.md). <!-- markdownlint-disable MD034 --> <!-- markdownlint-disable MD037 --> <!-- markdownlint-disable MD044 --> -<!-- vale gitlab.SentenceSpacing = NO --> +<!-- vale gitlab_base.SentenceSpacing = NO --> | Description | ID | Keywords | |:-------------------------------------------------------------------|:----------------------------------------------|:--------------------------------------| @@ -144,7 +144,7 @@ This table lists the secrets detected by [pipeline secret detection](index.md). | Yandex.Cloud IAM Cookie v1 | Yandex.Cloud IAM Cookie v1 - 1 | yandex | | Yandex.Cloud IAM Token v1 | Yandex.Cloud IAM Cookie v1 - 2 | yandex | -<!-- vale gitlab.SentenceSpacing = YES --> +<!-- vale gitlab_base.SentenceSpacing = YES --> <!-- markdownlint-enable MD044 --> <!-- markdownlint-enable MD037 --> <!-- markdownlint-enable MD034 --> diff --git a/doc/user/application_security/vulnerability_report/index.md b/doc/user/application_security/vulnerability_report/index.md index db048e4de5e27f096ff7f80ceb2c7c6b7c0e1dc8..e3dfa20050abbc8baece046e91ce9a89adfab16a 100644 --- a/doc/user/application_security/vulnerability_report/index.md +++ b/doc/user/application_security/vulnerability_report/index.md @@ -68,7 +68,7 @@ You can filter vulnerabilities in the vulnerability report to more efficiently t You can filter by: -<!-- vale gitlab.SubstitutionWarning = NO --> +<!-- vale gitlab_base.SubstitutionWarning = NO --> - **Status**: Detected, confirmed, dismissed, resolved. For details on what each status means, see [vulnerability status values](../vulnerabilities/index.md#vulnerability-status-values). @@ -77,7 +77,7 @@ You can filter by: - **Activity**: For more details, see [Activity filter](#activity-filter). - **Project**: Filter vulnerabilities in specific projects (available only for groups). -<!-- vale gitlab.SubstitutionWarning = YES --> +<!-- vale gitlab_base.SubstitutionWarning = YES --> ### Tool filter diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index 093e198f1b4f9ff0858b4f1c17ad941a82133ec7..90f53e27c129bbfa1ada67b0d82e9b838f94a63d 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -195,12 +195,8 @@ Attach a block or paragraph to a list item using a list continuation (which you * [ ] not checked ``` -<!-- vale gitlab.Spelling = NO --> - #### Callout -<!-- vale gitlab.Spelling = YES --> - ```plaintext // enable callout bubbles by adding `:icons: font` to the document header [,ruby] diff --git a/doc/user/compliance/compliance_center/compliance_violations_report.md b/doc/user/compliance/compliance_center/compliance_violations_report.md index 1a89d20b3b6dbf628b4b8c6359086a778ed734bb..5d6ec9f5b0163c96a1d5b98719cbfca4631c6bf1 100644 --- a/doc/user/compliance/compliance_center/compliance_violations_report.md +++ b/doc/user/compliance/compliance_center/compliance_violations_report.md @@ -57,7 +57,7 @@ Select a row to see details of the compliance violation. Each compliance violation has one of the following severities. -<!-- vale gitlab.SubstitutionWarning = NO --> +<!-- vale gitlab_base.SubstitutionWarning = NO --> | Icon | Severity level | |:------------------------|:---------------| @@ -67,7 +67,7 @@ Each compliance violation has one of the following severities. | **{severity-low}** | Low | | **{severity-info}** | Info | -<!-- vale gitlab.SubstitutionWarning = YES --> +<!-- vale gitlab_base.SubstitutionWarning = YES --> ### Violation types diff --git a/doc/user/gitlab_duo/turn_on_off.md b/doc/user/gitlab_duo/turn_on_off.md index c2ea41d8153319c1cb068e80157789d06d1bca55..e9aa664711b389af98b8e964c4c4c1aaaafe2b0c 100644 --- a/doc/user/gitlab_duo/turn_on_off.md +++ b/doc/user/gitlab_duo/turn_on_off.md @@ -89,7 +89,6 @@ Prerequisites: To turn off GitLab Duo for a group: -<!-- vale gitlab.Substitutions = NO --> 1. On the left sidebar, select **Search or go to** and find your group. 1. Select **Settings > General**. 1. Expand **Permissions and group features**. @@ -98,7 +97,6 @@ To turn off GitLab Duo for a group: all subgroups.  -<!-- vale gitlab.Substitutions = YES --> ### Turn off for a project @@ -130,14 +128,12 @@ Prerequisites: To turn off GitLab Duo for an instance: -<!-- vale gitlab.Substitutions = NO --> 1. On the left sidebar, at the bottom, select **Admin**. 1. Select **Settings > General** 1. Expand **AI-powered features**. 1. Clear the **Use Duo features** checkbox. 1. Optional. Select the **Enforce for all subgroups** checkbox to cascade the setting to all groups in the instance. -<!-- vale gitlab.Substitutions = YES --> NOTE: An [issue exists](https://gitlab.com/gitlab-org/gitlab/-/issues/441532) to allow administrators diff --git a/doc/user/group/access_and_permissions.md b/doc/user/group/access_and_permissions.md index 0f2db6b637a765f3f38163db3557abf70a34377b..b6c29cae93aea4692a15ce73f84e267a680d3b3f 100644 --- a/doc/user/group/access_and_permissions.md +++ b/doc/user/group/access_and_permissions.md @@ -305,7 +305,7 @@ DETAILS: To create group links via CN: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> 1. Select the **LDAP Server** for the link. 1. As the **Sync method**, select `LDAP Group cn`. @@ -313,7 +313,7 @@ To create group links via CN: 1. In the **LDAP Access** section, select the [permission level](../permissions.md) for users synced in this group. 1. Select **Add Synchronization**. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> ### Create group links via filter diff --git a/doc/user/group/import/migrated_items.md b/doc/user/group/import/migrated_items.md index 690734f508139b08358378974d2f2a6691d2d975..f970429e8ce9d82d4bf6a48c6a901756d5a63258 100644 --- a/doc/user/group/import/migrated_items.md +++ b/doc/user/group/import/migrated_items.md @@ -33,7 +33,7 @@ Any other group items are **not** migrated. Group items that are migrated to the destination GitLab instance include: -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> | Group item | Introduced in | |:---------------------|:----------------------------------------------------------------------------| @@ -61,7 +61,7 @@ Group items that are migrated to the destination GitLab instance include: once the relevant Project is migrated to the destination instance. 1. See [Memberships](index.md#memberships). -<!-- vale gitlab.OutdatedVersions = YES --> +<!-- vale gitlab_base.OutdatedVersions = YES --> ### Excluded items @@ -104,7 +104,7 @@ initiate project-only migrations using the [API](../../../api/bulk_imports.md). Project items that are migrated to the destination GitLab instance include: -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> | Project item | Introduced in | |:----------------------------------------|:---------------------------------------------------------------------------| @@ -135,7 +135,7 @@ Project items that are migrated to the destination GitLab instance include: | Uploads | [GitLab 14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/339401) | | Wikis | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/issues/345923) | -<!-- vale gitlab.OutdatedVersions = YES --> +<!-- vale gitlab_base.OutdatedVersions = YES --> **Footnotes:** @@ -147,7 +147,7 @@ Project items that are migrated to the destination GitLab instance include: Issue-related project items that are migrated to the destination GitLab instance include: -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> | Issue-related project item | Introduced in | |:--------------------------------|:---------------------------------------------------------------------------| @@ -158,13 +158,13 @@ Issue-related project items that are migrated to the destination GitLab instance | Merge request URL references | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/267947) | | Time tracking | [GitLab 14.4](https://gitlab.com/gitlab-org/gitlab/-/issues/267946) | -<!-- vale gitlab.OutdatedVersions = YES --> +<!-- vale gitlab_base.OutdatedVersions = YES --> ### Merge request-related items Merge request-related project items that are migrated to the destination GitLab instance include: -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> | Merge request-related project item | Introduced in | |:----------------------------------------|:--------------------------------------------------------------------| @@ -176,7 +176,7 @@ Merge request-related project items that are migrated to the destination GitLab | Issue URL references | [GitLab 15.6](https://gitlab.com/gitlab-org/gitlab/-/issues/267947) | | Time tracking | [GitLab 14.5](https://gitlab.com/gitlab-org/gitlab/-/issues/339403) | -<!-- vale gitlab.OutdatedVersions = YES --> +<!-- vale gitlab_base.OutdatedVersions = YES --> **Footnotes:** @@ -191,7 +191,7 @@ Merge request-related project items that are migrated to the destination GitLab Setting-related project items that are migrated to the destination GitLab instance include: -<!-- vale gitlab.OutdatedVersions = NO --> +<!-- vale gitlab_base.OutdatedVersions = NO --> | Setting-related project item | Introduced in | |:-----------------------------|:---------------------------------------------------------------------------| @@ -200,7 +200,7 @@ Setting-related project items that are migrated to the destination GitLab instan | Project properties | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75898) | | Service Desk | [GitLab 14.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75653) | -<!-- vale gitlab.OutdatedVersions = YES --> +<!-- vale gitlab_base.OutdatedVersions = YES --> ### Excluded items diff --git a/doc/user/group/saml_sso/group_sync.md b/doc/user/group/saml_sso/group_sync.md index 1be5e8ed4c67257afb2cdfeeaa8991d57f4ed492..a17ed07482770a62d171ffc3d155c10d87cff941 100644 --- a/doc/user/group/saml_sso/group_sync.md +++ b/doc/user/group/saml_sso/group_sync.md @@ -181,7 +181,7 @@ To integrate Microsoft Azure AD, you: ### Configure Azure AD -<!-- vale gitlab.SentenceSpacing = NO --> +<!-- vale gitlab_base.SentenceSpacing = NO --> 1. In the [Azure Portal](https://portal.azure.com), go to **Microsoft Entra ID > App registrations > All applications**, and select your GitLab SAML application. 1. Under **Essentials**, the **Application (client) ID** and **Directory (tenant) ID** values are displayed. Copy these values, because you need them for the GitLab configuration. @@ -197,7 +197,7 @@ To integrate Microsoft Azure AD, you: 1. Select **Add permissions** to save. 1. Select **Grant admin consent for `<application_name>`**, then on the confirmation dialog select **Yes**. The **Status** column for both permissions should change to a green check with **Granted for `<application_name>`**. -<!-- vale gitlab.SentenceSpacing = YES --> +<!-- vale gitlab_base.SentenceSpacing = YES --> ### Configure GitLab diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 843eb626cc74c01b34a133a75375b942c467561c..b77aca8138309dc6c286b8ef54b18672f84e0119 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -220,7 +220,7 @@ do_this_and_do_that_and_another_thing but_emphasis is_desired _here_ ``` -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> perform_complicated_task @@ -228,7 +228,7 @@ do_this_and_do_that_and_another_thing but_emphasis is_desired _here_ -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> --- @@ -427,8 +427,6 @@ Almost any URL you put into your text is auto-linked: - http://localhost:3000 ``` -<!-- vale gitlab.Spelling = NO --> - - <https://www.google.com> - <https://www.google.com> - <ftp://ftp.us.debian.org/debian/> @@ -436,8 +434,6 @@ Almost any URL you put into your text is auto-linked: - <a href="irc://irc.freenode.net">irc://irc.freenode.net</a> - <http://localhost:3000> -<!-- vale gitlab.Spelling = YES --> - ## Multimedia Embed images, videos, and audio. @@ -1490,13 +1486,13 @@ in GitLab might look different depending on the OS and browser used. Most emoji are natively supported on macOS, Windows, iOS, Android, and fall back on image-based emoji where there is no support. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> On Linux, you can download [Noto Color Emoji](https://github.com/googlefonts/noto-emoji) to get full native emoji support. Ubuntu 22.04 (like many modern Linux distributions) has this font installed by default. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> To learn more about adding custom emoji, see [Custom emoji](emoji_reactions.md#custom-emoji). @@ -1828,12 +1824,12 @@ The formula for water is H<sub>2</sub>O while the equation for the theory of relativity is E = mc<sup>2</sup>. ``` -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> The formula for water is H<sub>2</sub>O while the equation for the theory of relativity is E = mc<sup>2</sup>. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> GitLab Flavored Markdown doesn't support the Redcarpet superscript syntax ( `x^2` ). diff --git a/doc/user/okrs.md b/doc/user/okrs.md index 8b4109883624ff28532317963097482488ad7c74..4b9d381238252364297a9d9e464696f4491a2ca6 100644 --- a/doc/user/okrs.md +++ b/doc/user/okrs.md @@ -50,9 +50,9 @@ By achieving a specific outcome (key result), you create progress for the linked To know if your OKR makes sense, you can use this sentence: -<!-- vale gitlab.FutureTense = NO --> +<!-- vale gitlab_base.FutureTense = NO --> > I/we will accomplish (objective) by (date) through attaining and achieving the following metrics (key results). -<!-- vale gitlab.FutureTense = YES --> +<!-- vale gitlab_base.FutureTense = YES --> To learn how to create better OKRs and how we use them at GitLab, see the [Objectives and Key Results handbook page](https://handbook.gitlab.com/handbook/company/okrs/). diff --git a/doc/user/packages/package_registry/index.md b/doc/user/packages/package_registry/index.md index 0a7131a25140f45a34b17db014a52572ed51a31c..bef73f34ff07c8c171fe10e19b2cd7bdc4d66859 100644 --- a/doc/user/packages/package_registry/index.md +++ b/doc/user/packages/package_registry/index.md @@ -186,7 +186,7 @@ This table lists unsupported package manager formats that we are accepting contr Consider contributing to GitLab. This [development documentation](../../../development/packages/index.md) guides you through the process. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> | Format | Status | | --------- | ------------------------------------------------------------- | @@ -202,4 +202,4 @@ guides you through the process. | Swift | [#12233](https://gitlab.com/gitlab-org/gitlab/-/issues/12233) | | Vagrant | [#36899](https://gitlab.com/gitlab-org/gitlab/-/issues/36899) | -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> diff --git a/doc/user/profile/account/two_factor_authentication.md b/doc/user/profile/account/two_factor_authentication.md index 3d6d46a1dea9df2247af2cdae3ddcd82f71dea48..a355f3b5c89e6a7af88b07ac350b1e5485596a76 100644 --- a/doc/user/profile/account/two_factor_authentication.md +++ b/doc/user/profile/account/two_factor_authentication.md @@ -63,8 +63,6 @@ Your account email must be confirmed to enable 2FA. To enable 2FA with a one-time password: -<!-- vale gitlab.Substitutions = NO --> - 1. **In GitLab:** 1. Access your [**User settings**](../index.md#access-your-user-settings). 1. Select **Account**. @@ -88,8 +86,6 @@ To enable 2FA with a one-time password: 1. Enter your current password. 1. Select **Submit**. -<!-- vale gitlab.Substitutions = YES --> - If you entered the correct pin, GitLab displays a list of [recovery codes](#recovery-codes). Download them and keep them in a safe place. @@ -154,8 +150,6 @@ Configure FortiAuthenticator in GitLab. On your GitLab server: (Linux package installations) or [restart](../../../administration/restart_gitlab.md#self-compiled-installations) (self-compiled installations). -<!-- vale gitlab.Substitutions = NO --> - ### Enable one-time password using Cisco Duo > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15760) in GitLab 15.10. @@ -180,8 +174,6 @@ GitLab 15.10 has been tested with Cisco Duo version D261.14 #### Configure Cisco Duo in GitLab -<!-- vale gitlab.Substitutions = YES --> - On your GitLab server: 1. Open the configuration file. diff --git a/doc/user/project/autocomplete_characters.md b/doc/user/project/autocomplete_characters.md index 8d03b3b469f6cce3767545cde949bedb19309d6a..bb3a5f3437deb9fb6bdecc26bfe1e0de6508f74a 100644 --- a/doc/user/project/autocomplete_characters.md +++ b/doc/user/project/autocomplete_characters.md @@ -37,7 +37,7 @@ Autocomplete characters are useful when combined with [Quick Actions](quick_acti Assume your GitLab instance includes the following users: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> | Username | Name | | :-------------- | :--- | @@ -47,7 +47,7 @@ Assume your GitLab instance includes the following users: | logan_gutkowski | Lee Wuckert | | shelba | Josefine Haley | -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> User autocompletion sorts by the users whose username or name start with your query first. For example, typing `@lea` shows `leanna` first and typing `@ros` shows `Rosemarie Rogahn` and `Rosy Grant` first. diff --git a/doc/user/project/issues/csv_export.md b/doc/user/project/issues/csv_export.md index 18adad6bccbe2a1190ddfd690e0aeefe2977b12e..698b1c0193d23248833a00c3e36e6a221f9e8ab9 100644 --- a/doc/user/project/issues/csv_export.md +++ b/doc/user/project/issues/csv_export.md @@ -15,12 +15,12 @@ You can export issues from GitLab to a plain-text CSV file. The CSV file is attached to an email, and sent to your default notification email address. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> CSV files can be used with any plotter or spreadsheet-based program, like Microsoft Excel, OpenOffice Calc, or Google Sheets. Use a CSV list of issues to: -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> - Create a snapshot of issues for offline analysis, or to share with other teams who might not be in GitLab. diff --git a/doc/user/project/issues/design_management.md b/doc/user/project/issues/design_management.md index 84de1c27ccd7a9abfc9d7ce108589c30b6b74562..b3f5dcdc1ad434fcbf78cc8805153a4d06dc2deb 100644 --- a/doc/user/project/issues/design_management.md +++ b/doc/user/project/issues/design_management.md @@ -116,10 +116,10 @@ To add a design to an issue: 1. Either: - Select **Upload designs** and then select images from your file browser. You can select up to 10 files at once. - <!-- vale gitlab.SubstitutionWarning = NO --> + <!-- vale gitlab_base.SubstitutionWarning = NO --> - Select **click to upload** and then select images from your file browser. You can select up to 10 files at once. - <!-- vale gitlab.SubstitutionWarning = YES --> + <!-- vale gitlab_base.SubstitutionWarning = YES --> - Drag a file from your file browser and drop it in the drop zone in the **Designs** section. @@ -216,10 +216,10 @@ You can start [discussions](../../discussions/index.md) on uploaded designs. To 1. Go to an issue. 1. Select the design. -<!-- vale gitlab.SubstitutionWarning = NO --> +<!-- vale gitlab_base.SubstitutionWarning = NO --> <!-- Disable Vale so it doesn't catch "click" --> 1. Click or tap the image. A pin is created in that spot, identifying the discussion's location. -<!-- vale gitlab.SubstitutionWarning = YES --> +<!-- vale gitlab_base.SubstitutionWarning = YES --> 1. Enter your message. 1. Select **Comment**. diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md index 0b26e797c22efe2dd3f070d17797234f1bfab0ae..4177559aa77902fe6d5034f6ecf17d4c5b0de0e1 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/dns_concepts.md @@ -30,7 +30,7 @@ to do it for you. To help you out, we've gathered some instructions on how to do that for the most popular hosting services: -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> - [123-reg](https://www.123-reg.co.uk/support/domains/domain-name-server-dns-management-guide/) - [Amazon](https://docs.aws.amazon.com/AmazonS3/latest/userguide/website-hosting-custom-domain-walkthrough.html) @@ -46,7 +46,7 @@ for the most popular hosting services: - [Microsoft](https://learn.microsoft.com/en-us/windows-server/networking/dns/manage-resource-records?tabs=powershell) - [Namecheap](https://www.namecheap.com/support/knowledgebase/subcategory/2237/host-records-setup/) -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> If your hosting service is not listed above, you can just try to search the web for `how to add dns record on <my hosting service>`. diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md index f0f58cff8413ed0dad09369cd5fdef62b49141b7..df40921d6223634565fb68946f9e01caaeb0785d 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/ssl_tls_concepts.md @@ -33,11 +33,11 @@ When HTTPS came out in 1990, [SSL](https://en.wikipedia.org/wiki/Transport_Layer security measure, necessary just for big companies like banks and shopping sites with financial transactions. -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> Now we have a different picture. [According to Josh Aas](https://letsencrypt.org/2015/10/29/phishing-and-malware.html), Executive Director at [Internet Security Research Group (ISRG)](https://en.wikipedia.org/wiki/Internet_Security_Research_Group): -<!-- vale gitlab.rulename = YES --> +<!-- vale gitlab_base.rulename = YES --> > _We've since come to realize that HTTPS is important for almost all websites. It's important for any website that allows people to sign in with a password, any website that [tracks its users](https://www.washingtonpost.com/news/the-switch/wp/2013/12/10/nsa-uses-google-cookies-to-pinpoint-targets-for-hacking/) in any way, any website that [doesn't want its content altered](https://arstechnica.com/tech-policy/2014/09/why-comcasts-javascript-ad-injections-threaten-security-net-neutrality/), and for any site that offers content people might not want others to know they are consuming. We've also learned that any site not secured by HTTPS [can be used to attack other sites](https://krebsonsecurity.com/2015/04/dont-be-fodder-for-chinas-great-cannon/)._ diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index cf3b6899b6fbfe446c149067879ec70c37a528c2..a4266254d31359e56d1697c83dddd1e27af36118 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -331,7 +331,7 @@ To compare branches in a repository: - You can combine operators: `^chore/*migration$` matches `chore/user-data-migration`. 1. Select the **Target** repository and branch. Exact matches are shown first. 1. Below **Show changes**, select the method to compare branches: - <!-- vale gitlab.SubstitutionWarning = NO --> + <!-- vale gitlab_base.SubstitutionWarning = NO --> <!-- Disable Vale so it doesn't flag "since" --> - **Only incoming changes from source** (default) shows differences from the source branch since the latest common commit on both branches. @@ -344,7 +344,7 @@ To compare branches in a repository: branches. This method uses the `git diff <from> <to>` [Git command](https://git-scm.com/docs/git-diff#Documentation/git-diff.txt-emgitdiffemltoptionsgt--merge-baseltcommitgtltcommitgt--ltpathgt82308203). - <!-- vale gitlab.SubstitutionWarning = YES --> + <!-- vale gitlab_base.SubstitutionWarning = YES --> 1. Select **Compare** to show the list of commits, and changed files. 1. Optional. To reverse the **Source** and **Target**, select **Swap revisions** (**{substitute}**). diff --git a/doc/user/project/requirements/index.md b/doc/user/project/requirements/index.md index 5f8fde3150b4e9022d78c0743c9764362242c335..c5edbe2173e3ac0741da1f6e630598f26508db7e 100644 --- a/doc/user/project/requirements/index.md +++ b/doc/user/project/requirements/index.md @@ -312,12 +312,12 @@ To export requirements: ### Exported CSV file format -<!-- vale gitlab.Spelling = NO --> +<!-- vale gitlab_base.Spelling = NO --> You can preview the exported CSV file in a spreadsheet editor, such as Microsoft Excel, OpenOffice Calc, or Google Sheets. -<!-- vale gitlab.Spelling = YES --> +<!-- vale gitlab_base.Spelling = YES --> The exported CSV file contains the following headers: