diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-25 09:10:14 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-25 09:10:14 +0000 |
commit | 919f0e86ba5997120d02601e648543d1682e8260 (patch) | |
tree | a19cd58b0d82a56f46e6c02535253461149b1c6b /doc | |
parent | 866b1f8ed7db9b29b1188ffcba309b92572f354b (diff) | |
download | gitlab-ce-919f0e86ba5997120d02601e648543d1682e8260.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
53 files changed, 76 insertions, 67 deletions
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml index 78a86e27456..6160eb85c8e 100644 --- a/doc/.vale/gitlab/Admin.yml +++ b/doc/.vale/gitlab/Admin.yml @@ -3,7 +3,7 @@ # # Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index 5912c4707fd..299bd334eed 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -7,7 +7,7 @@ # - Alert boxes with the note text on the same line # - Alert boxes using words other than "NOTE" or "WARNING" # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Alert box "%s" must use the formatting in the style guide.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes diff --git a/doc/.vale/gitlab/BadPlurals.yml b/doc/.vale/gitlab/BadPlurals.yml index 533805c67b0..a1f53855de2 100644 --- a/doc/.vale/gitlab/BadPlurals.yml +++ b/doc/.vale/gitlab/BadPlurals.yml @@ -3,7 +3,7 @@ # # Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Rewrite "%s" to be plural, without parentheses.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#s diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index 33425693d53..b98ebf334e4 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -3,7 +3,7 @@ # # Verifies that badges are not mixed case, which won't render properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Badge "%s" must be capitalized.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index c63cbd917c7..11652e41da7 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -3,7 +3,7 @@ # # Checks that US spelling is used instead of British spelling. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use the US spelling "%s" instead of the British "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language diff --git a/doc/.vale/gitlab/CIConfigFile.yml b/doc/.vale/gitlab/CIConfigFile.yml index 5a65e51ea16..98fa1aa78e8 100644 --- a/doc/.vale/gitlab/CIConfigFile.yml +++ b/doc/.vale/gitlab/CIConfigFile.yml @@ -3,7 +3,7 @@ # # Checks that the `.gitlab-ci.yml` file is referenced properly. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'The CI/CD configuration file should be exactly: `.gitlab-ci.yml`' link: https://docs.gitlab.com/ee/development/documentation/versions.html diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 6c2d94e7b8d..6b7ad8d08b3 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -3,7 +3,7 @@ # # Ensures all codeblock language tags use the full name, not aliases. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index a59fe64d990..8646ad45608 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -3,7 +3,7 @@ # # Ensures all code blocks using `curl` wrap URL strings in quotation marks. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'For consistency across all cURL examples, always wrap the URL in double quotes ("): %s' link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 040fd3d8a8f..213f470cb43 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -3,7 +3,7 @@ # # Checks for words that indicate a product or feature may change in the future. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Avoid words like "%s" when you write about future features. Our documentation is about the current state of the product.' level: suggestion diff --git a/doc/.vale/gitlab/DefaultBranch.yml b/doc/.vale/gitlab/DefaultBranch.yml index 4bc68433c6d..1ac7b84c440 100644 --- a/doc/.vale/gitlab/DefaultBranch.yml +++ b/doc/.vale/gitlab/DefaultBranch.yml @@ -3,7 +3,7 @@ # # Do not refer to the default branch as the "master" branch, if possible. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Use "default branch" or `main` instead of `master`, when possible.' level: warning diff --git a/doc/.vale/gitlab/Dropdown.yml b/doc/.vale/gitlab/Dropdown.yml index 691d44d1a48..6163e765989 100644 --- a/doc/.vale/gitlab/Dropdown.yml +++ b/doc/.vale/gitlab/Dropdown.yml @@ -3,7 +3,7 @@ # # Catches many ways the phrase 'dropdown list' can be fumbled. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Use "dropdown list".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#dropdown-list diff --git a/doc/.vale/gitlab/EOLWhitespace.yml b/doc/.vale/gitlab/EOLWhitespace.yml index e160b706014..64f505b2bae 100644 --- a/doc/.vale/gitlab/EOLWhitespace.yml +++ b/doc/.vale/gitlab/EOLWhitespace.yml @@ -3,7 +3,7 @@ # # Checks that there is no useless whitespace at the end of lines. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Lines should not end with whitespace characters.' link: https://docs.gitlab.com/ee/development/documentation/versions.html diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index 36f1202aef1..06121492e99 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -3,7 +3,7 @@ # # Suggests the correct way to describe elements in a form. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'When describing elements, %s "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index 6fc93d9515c..ab7855a78db 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -3,7 +3,7 @@ # # Checks for use of first person pronouns. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: '"%s" is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.' level: warning diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml index 64e79612fff..0809f5f9063 100644 --- a/doc/.vale/gitlab/FutureTense.yml +++ b/doc/.vale/gitlab/FutureTense.yml @@ -3,7 +3,7 @@ # # Checks for use of future tense in sentences. Present tense is strongly preferred. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Avoid using future tense: "%s". Use present tense instead.' ignorecase: true diff --git a/doc/.vale/gitlab/HeadingContent.yml b/doc/.vale/gitlab/HeadingContent.yml index c2dd2a5c6c2..50af625ce19 100644 --- a/doc/.vale/gitlab/HeadingContent.yml +++ b/doc/.vale/gitlab/HeadingContent.yml @@ -3,7 +3,7 @@ # # Checks for generic, unhelpful subheadings. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Rename the subheading "%s", or re-purpose the content elsewhere.' level: warning diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 1ebb6a97cf8..66d89a26717 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -3,7 +3,7 @@ # # Suggests alternatives for words that foster ableism. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language diff --git a/doc/.vale/gitlab/InclusionCultural.yml b/doc/.vale/gitlab/InclusionCultural.yml index 6f63d1725fc..94662d4bc42 100644 --- a/doc/.vale/gitlab/InclusionCultural.yml +++ b/doc/.vale/gitlab/InclusionCultural.yml @@ -3,7 +3,7 @@ # # Suggests alternatives for words that are culturally inappropriate. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index 313a1cc42dc..62302d21ae7 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -3,7 +3,7 @@ # # Suggests alternatives for words that are gender-specific. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use inclusive language. Consider "%s" instead of "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language diff --git a/doc/.vale/gitlab/InternalLinkCase.yml b/doc/.vale/gitlab/InternalLinkCase.yml index c00e633426b..3e40f9f4a61 100644 --- a/doc/.vale/gitlab/InternalLinkCase.yml +++ b/doc/.vale/gitlab/InternalLinkCase.yml @@ -3,7 +3,7 @@ # # Checks that anchor fragments on internal links are in lower-case. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Links to subheadings in GitLab docs must be in lower-case: "%s"' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 52142b50dfc..45794708a3f 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -3,7 +3,7 @@ # # Checks that internal links have .md extenstion and not .html extension. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Link "%s" must link directly to a file and use the .md file extension.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab/InternalLinkFormat.yml index b9ee83b7f5c..d5572d8d485 100644 --- a/doc/.vale/gitlab/InternalLinkFormat.yml +++ b/doc/.vale/gitlab/InternalLinkFormat.yml @@ -3,7 +3,7 @@ # # Checks that internal link paths don't start with "./", which is not needed. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Link "%s" must not start with "./".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 12553a801a1..306ffb08355 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -3,7 +3,7 @@ # # Checks for use of Latin terms. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use "%s" instead of "%s", but consider rewriting the sentence.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list diff --git a/doc/.vale/gitlab/Markdown_emoji.yml b/doc/.vale/gitlab/Markdown_emoji.yml index ac0dab2d69d..2cb4f54859e 100644 --- a/doc/.vale/gitlab/Markdown_emoji.yml +++ b/doc/.vale/gitlab/Markdown_emoji.yml @@ -3,7 +3,7 @@ # # Check for use of GLFM emoji syntax (https://docs.gitlab.com/ee/user/markdown.html#emojis), which doesn't render correctly in documentation. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'This appears to be GLFM emoji syntax. Replace "%s" with GitLab SVGs or Unicode emojis.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/#gitlab-svg-icons diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab/MeaningfulLinkWords.yml index 4a255e5aae4..c13ec2f0221 100644 --- a/doc/.vale/gitlab/MeaningfulLinkWords.yml +++ b/doc/.vale/gitlab/MeaningfulLinkWords.yml @@ -3,7 +3,7 @@ # # Checks for the presence of semantically unhelpful words in link text. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Improve SEO and accessibility by rewriting "%s" in the link text.' level: warning diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab/MergeConflictMarkers.yml index 4f216ac34c5..bbe01820a84 100644 --- a/doc/.vale/gitlab/MergeConflictMarkers.yml +++ b/doc/.vale/gitlab/MergeConflictMarkers.yml @@ -3,7 +3,7 @@ # # Checks for the presence of merge conflict markers. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Merge conflict marker "%s" found.' link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request diff --git a/doc/.vale/gitlab/MultiLineLinks.yml b/doc/.vale/gitlab/MultiLineLinks.yml index 64ad017f16c..3e73306e97d 100644 --- a/doc/.vale/gitlab/MultiLineLinks.yml +++ b/doc/.vale/gitlab/MultiLineLinks.yml @@ -3,7 +3,7 @@ # # Checks that links are all on a single line. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Link "%s" must be on a single line, even if very long.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria diff --git a/doc/.vale/gitlab/NonStandardQuotes.yml b/doc/.vale/gitlab/NonStandardQuotes.yml index f31d615eb19..c214488dfc0 100644 --- a/doc/.vale/gitlab/NonStandardQuotes.yml +++ b/doc/.vale/gitlab/NonStandardQuotes.yml @@ -3,7 +3,7 @@ # # Use only standard single and double quotes, not left or right quotes. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' level: warning diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml index f25de44ad17..b469304977e 100644 --- a/doc/.vale/gitlab/OutdatedVersions.yml +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -3,7 +3,7 @@ # # Checks for references to versions of GitLab that are no longer supported. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Can this reference to "%s" be refactored?' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 1716145b26a..814b0157699 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -3,7 +3,7 @@ # # Checks for the lack of an Oxford comma. In some cases, will catch overly complex sentence structures with lots of commas. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Use a comma before the last "and" or "or" in a list of four or more items.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation diff --git a/doc/.vale/gitlab/Possessive.yml b/doc/.vale/gitlab/Possessive.yml index 92ae66543a2..8f4f93ab93c 100644 --- a/doc/.vale/gitlab/Possessive.yml +++ b/doc/.vale/gitlab/Possessive.yml @@ -3,7 +3,7 @@ # # The word GitLab should not be used in the possessive form. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Rewrite '%s' to not use 's." level: error diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab/ReadingLevel.yml index cd7597ee8dc..ca3ddea46bf 100644 --- a/doc/.vale/gitlab/ReadingLevel.yml +++ b/doc/.vale/gitlab/ReadingLevel.yml @@ -4,6 +4,8 @@ # Checks the Flesch-Kincaid reading level. # # https://docs.errata.ai/vale/styles#metric +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: metric message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index ca9948844f8..cc6f0c0a467 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -3,7 +3,7 @@ # # Checks for reference-style links that should be converted to inline links. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Link "%s" must be inline.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index 14ffc4bd0b8..582d0faba09 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -3,7 +3,7 @@ # # Checks for the presence of absolute hyperlinks that should be relative. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Link "%s" must be a relative link with a .md extension.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml index ce6ce8b5691..0e0d1fdbb52 100644 --- a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml +++ b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml @@ -3,7 +3,7 @@ # # Checks for the presence of double slashes in relative URLs. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Relative links must not include a double slash.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links-to-internal-documentation diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab/Repetition.yml index c4b0cc14192..8f9d482b22b 100644 --- a/doc/.vale/gitlab/Repetition.yml +++ b/doc/.vale/gitlab/Repetition.yml @@ -3,7 +3,7 @@ # # Checks for duplicate words, like `the the` or `and and`. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: repetition message: '"%s" is repeated.' level: error diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index c60df1803e2..394bcbf3c70 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -3,7 +3,7 @@ # # Counts words in a sentence and alerts if a sentence exceeds 25 words. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: occurrence message: 'Shorter sentences improve readability (max 25 words).' scope: sentence diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index 0288abe834f..8589f0ffa9b 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -3,7 +3,7 @@ # # Checks for incorrect spacing (no spaces, or more than one space) around punctuation. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: '"%s" must contain one and only one space.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index 44e78f89c20..86f38045bc0 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -3,7 +3,7 @@ # # Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Avoid words like "%s" that imply ease of use, because the user may find this action hard.' level: suggestion diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 4ebaf7bfb70..5ea813d62b0 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -8,7 +8,7 @@ # Commands, like `git clone` must use backticks, and must not be added to the # exceptions. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: spelling message: 'Spelling check: "%s"?' level: warning diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index ce8868a82b9..164ea5a32b6 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -4,7 +4,7 @@ # Suggests better options for frequently misused terms that are often - but not always - incorrect. # SubstitutionWarning.yml and Substitutions.yml also exist. # -# For a list of all options, see https://errata-ai.github.io/vale/styles/ +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Consider %s instead of "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index d17015b97fd..65e4e7dacb2 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -4,7 +4,7 @@ # Checks for misused terms or common shorthand that should never be used at GitLab, but can't be flagged as errors. # Substitutions.yml and SubstitionSuggestions.yml also exist. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'If possible, use "%s" instead of "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index af426fa7e06..cc299665331 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -4,7 +4,7 @@ # Checks for misused terms that should never be used at GitLab. # SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use "%s" instead of "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab/ToDo.yml index a3725cb7f6b..7781097c938 100644 --- a/doc/.vale/gitlab/ToDo.yml +++ b/doc/.vale/gitlab/ToDo.yml @@ -3,7 +3,7 @@ # # You should not use "To Do", unless it refers to the UI element. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: 'Use "to-do item" in most cases, or "Add a to do" if referring to the UI button.' link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#feature-names diff --git a/doc/.vale/gitlab/UnclearAntecedent.yml b/doc/.vale/gitlab/UnclearAntecedent.yml index 5f238598d9f..36de9fa532b 100644 --- a/doc/.vale/gitlab/UnclearAntecedent.yml +++ b/doc/.vale/gitlab/UnclearAntecedent.yml @@ -3,7 +3,7 @@ # # Checks for words that need a noun for clarity. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "'%s' is not precise. Try rewriting with a specific subject and verb." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#this-these-that-those diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index dc05aa05730..d966d7d3001 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -3,7 +3,7 @@ # # Checks for use of all uppercase letters with unknown reason. # -# For a list of all options, see https://docs.errata.ai/vale/styles. +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: conditional message: "'%s' is uppercase. Use lowercase or `backticks` if possible. Otherwise add this word to the rule's exception list." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-uppercase-acronym-test diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index 571fba52ab7..6afce45e6d6 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -9,7 +9,7 @@ # - `> Introduced in GitLab 14.0. # - `> Removed in GitLab 15.0. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.' link: https://docs.gitlab.com/ee/development/documentation/versions.html diff --git a/doc/.vale/gitlab/VersionTextSingleLine.yml b/doc/.vale/gitlab/VersionTextSingleLine.yml index f76574bcf8a..e1f045efbd9 100644 --- a/doc/.vale/gitlab/VersionTextSingleLine.yml +++ b/doc/.vale/gitlab/VersionTextSingleLine.yml @@ -3,7 +3,7 @@ # # Verifies that single-item version notes don't have a hyphen. # -# For a list of all options, see https://errata-ai.gitbook.io/vale/getting-started/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: 'Version text with only a single item must not start with a hyphen.' link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab/Wordy.yml index 7888d16dadb..047df02adce 100644 --- a/doc/.vale/gitlab/Wordy.yml +++ b/doc/.vale/gitlab/Wordy.yml @@ -3,7 +3,7 @@ # # Suggests shorter versions of wordy phrases. # -# For a list of all options, see https://docs.errata.ai/vale/styles +# For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution message: '%s "%s".' link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html @@ -11,7 +11,6 @@ level: suggestion ignorecase: true swap: in order to: "Be concise: use 'to' rather than" - needs? to: "Rewrite the sentence, or use 'must', instead of" note that: "Be concise: rewrite the sentence to not use" please: "Remove this word from the sentence: " respectively: "Rewrite the sentence to be more precise, instead of using " diff --git a/doc/administration/file_hooks.md b/doc/administration/file_hooks.md index 8fafb258593..f8b55a7c680 100644 --- a/doc/administration/file_hooks.md +++ b/doc/administration/file_hooks.md @@ -7,10 +7,8 @@ type: reference # File hooks **(FREE SELF)** -> Renamed feature from Plugins to File hooks in GitLab 12.8. - -With custom file hooks, GitLab administrators can introduce custom integrations -without modifying the GitLab source code. +Use custom file hooks (not to be confused with [server hooks](server_hooks.md) or [system hooks](system_hooks.md)), +to introduce custom integrations without modifying the GitLab source code. A file hook runs on each event. You can filter events or projects in a file hook's code, and create many file hooks as you need. Each file hook is diff --git a/doc/administration/server_hooks.md b/doc/administration/server_hooks.md index 6ab4f476e5e..b14998fc80f 100644 --- a/doc/administration/server_hooks.md +++ b/doc/administration/server_hooks.md @@ -9,7 +9,8 @@ disqus_identifier: 'https://docs.gitlab.com/ee/administration/custom_hooks.html' > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/196051) in GitLab 12.8 replacing Custom Hooks. -Server hooks run custom logic on the GitLab server. Users can use them to run Git-related tasks such as: +Server hooks (not to be confused with [system hooks](system_hooks.md) or [file hooks](file_hooks.md)) run custom logic +on the GitLab server. You can use them to run Git-related tasks such as: - Enforcing specific commit policies. - Performing tasks based on the state of the repository. diff --git a/doc/administration/system_hooks.md b/doc/administration/system_hooks.md index 56e73150616..c8b985688b6 100644 --- a/doc/administration/system_hooks.md +++ b/doc/administration/system_hooks.md @@ -7,7 +7,8 @@ type: reference # System hooks **(FREE SELF)** -Your GitLab instance can perform HTTP POST requests on the following events: +System hooks (not to be confused with [server hooks](server_hooks.md) or [file hooks](file_hooks.md)) perform HTTP POST +requests and are triggered on the following events: - `group_create` - `group_destroy` @@ -31,21 +32,18 @@ Your GitLab instance can perform HTTP POST requests on the following events: - `user_update_for_group` - `user_update_for_team` -The triggers for most of these are self-explanatory, but `project_update` and -`project_rename` deserve some clarification: `project_update` is fired any time -an attribute of a project is changed (including name, description, and tags) -_unless_ the `path` attribute is also changed. In that case, a `project_rename` -is triggered instead (so that, for instance, if all you care about is the -repository URL, you can just listen for `project_rename`). +The triggers for most of these are self-explanatory, but `project_update` and `project_rename` require clarification: -`user_failed_login` is sent whenever a _blocked_ user attempts to sign in and is -denied access. +- `project_update` triggers when an attribute of a project is changed (including name, description, and tags) + **except** when the `path` attribute is also changed. +- `project_rename` triggers when an attribute of a project (including `path`) is changed. If you only care about the + repository URL, just listen for `project_rename`. -System hooks can be used, for example, for logging or changing information in an -LDAP server. +`user_failed_login` is sent whenever a **blocked** user attempts to sign in and is denied access. -In addition to these default events, you can enable triggers for other events, -such as push events, and disable the `repository_update` event +As an example, use system hooks for logging or changing information in an LDAP server. + +You can also enable triggers for other events, such as push events, and disable the `repository_update` event when you create a system hook. NOTE: diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 23c36796f16..c2f431ce31c 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -16297,6 +16297,7 @@ Represents vulnerability finding of a security report on the pipeline. | <a id="projectjiraimportstatus"></a>`jiraImportStatus` | [`String`](#string) | Status of Jira import background job of the project. | | <a id="projectjiraimports"></a>`jiraImports` | [`JiraImportConnection`](#jiraimportconnection) | Jira imports into the project. (see [Connections](#connections)) | | <a id="projectjobsenabled"></a>`jobsEnabled` | [`Boolean`](#boolean) | Indicates if CI/CD pipeline jobs are enabled for the current user. | +| <a id="projectlanguages"></a>`languages` | [`[RepositoryLanguage!]`](#repositorylanguage) | Programming languages used in the project. | | <a id="projectlastactivityat"></a>`lastActivityAt` | [`Time`](#time) | Timestamp of the project last activity. | | <a id="projectlfsenabled"></a>`lfsEnabled` | [`Boolean`](#boolean) | Indicates if the project has Large File Storage (LFS) enabled. | | <a id="projectmergecommittemplate"></a>`mergeCommitTemplate` | [`String`](#string) | Template used to create merge commit message in merge requests. | @@ -17968,6 +17969,16 @@ Returns [`Tree`](#tree). | <a id="repositoryblobstoredexternally"></a>`storedExternally` | [`Boolean`](#boolean) | Whether the blob's content is stored externally (for instance, in LFS). | | <a id="repositoryblobwebpath"></a>`webPath` | [`String`](#string) | Web path of the blob. | +### `RepositoryLanguage` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="repositorylanguagecolor"></a>`color` | [`Color`](#color) | Color to visualize the repository language. | +| <a id="repositorylanguagename"></a>`name` | [`String!`](#string) | Name of the repository language. | +| <a id="repositorylanguageshare"></a>`share` | [`Float`](#float) | Percentage of the repository's languages. | + ### `Requirement` Represents a requirement. |