diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-01 03:10:27 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-01 03:10:27 +0300 |
commit | a149dffe2f221544ce239658e1e0fad06a2726a2 (patch) | |
tree | 87b71776b0ce5084235b0a26c2acf0fa1c910eee /doc | |
parent | 16776d7f4fdb0cef173fcebb189c53b5bc0ecd39 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
72 files changed, 136 insertions, 135 deletions
diff --git a/doc/.vale/gitlab/AlertBoxStyle.yml b/doc/.vale/gitlab/AlertBoxStyle.yml index 299bd334eed..0a4514fa3c8 100644 --- a/doc/.vale/gitlab/AlertBoxStyle.yml +++ b/doc/.vale/gitlab/AlertBoxStyle.yml @@ -3,13 +3,13 @@ # # Makes sure alert boxes are used with block quotes. Checks for 3 formatting issues: # -# - Alert boxes inside a block quote (">") +# - Alert boxes inside a block quote ('>') # - Alert boxes with the note text on the same line -# - Alert boxes using words other than "NOTE" or "WARNING" +# - Alert boxes using words other than 'NOTE' or 'WARNING' # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Alert box "%s" must use the formatting in the style guide.' +message: "Update the format of the '%s' alert box. View the style guide for details." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#alert-boxes level: error nonword: true diff --git a/doc/.vale/gitlab/BadPlurals.yml b/doc/.vale/gitlab/BadPlurals.yml index a1f53855de2..9cdb8661708 100644 --- a/doc/.vale/gitlab/BadPlurals.yml +++ b/doc/.vale/gitlab/BadPlurals.yml @@ -1,11 +1,11 @@ --- # Warning: gitlab.BadPlurals # -# Don't write plural words with the '(s)' construction. "HTTP(S)" is acceptable. +# Don't write plural words with the '(s)' construction. 'HTTP(S)' is acceptable. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rewrite "%s" to be plural, without parentheses.' +message: "Rewrite '%s' to be plural without parentheses." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#s level: warning ignorecase: true diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index b98ebf334e4..6e77c3fe822 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Badge "%s" must be capitalized.' +message: "Capitalize the '%s' badge." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#product-tier-badges level: error scope: raw diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index 11652e41da7..432ed302e11 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use the US spelling "%s" instead of the British "%s".' +message: "Use the US spelling '%s' instead of the British '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: error ignorecase: true diff --git a/doc/.vale/gitlab/CIConfigFile.yml b/doc/.vale/gitlab/CIConfigFile.yml index 98fa1aa78e8..4d2ba454410 100644 --- a/doc/.vale/gitlab/CIConfigFile.yml +++ b/doc/.vale/gitlab/CIConfigFile.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The CI/CD configuration file should be exactly: `.gitlab-ci.yml`' +message: "Change the file name to be exactly '.gitlab-ci.yml'." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml index 6b7ad8d08b3..9d5efe7f60a 100644 --- a/doc/.vale/gitlab/CodeblockFences.yml +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Syntax highlighting hint "%s" must be one of: yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript.' +message: "Instead of '%s' for the code block, use yaml, ruby, plaintext, markdown, javascript, shell, golang, python, dockerfile, or typescript." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#code-blocks level: error scope: raw diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml index 8646ad45608..efe7aa23832 100644 --- a/doc/.vale/gitlab/CurlStringsQuoted.yml +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -5,7 +5,7 @@ # # 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' +message: "For the cURL example, use double quotes around the URL: %s" link: https://docs.gitlab.com/ee/development/documentation/restful_api_styleguide.html#curl-commands level: error scope: code diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 213f470cb43..57b95dcf4ac 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -5,10 +5,10 @@ # # 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.' +message: "Remove '%s'. The documentation reflects the current state of the product." level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#promising-features-in-future-versions +link: https://docs.gitlab.com/ee/development/documentation/versions.html#promising-features-in-future-versions tokens: - currently - yet diff --git a/doc/.vale/gitlab/DefaultBranch.yml b/doc/.vale/gitlab/DefaultBranch.yml index 1ac7b84c440..86c627bcfe3 100644 --- a/doc/.vale/gitlab/DefaultBranch.yml +++ b/doc/.vale/gitlab/DefaultBranch.yml @@ -1,14 +1,14 @@ --- # Warning: gitlab.DefaultBranch # -# Do not refer to the default branch as the "master" branch, if possible. +# Do not refer to the default branch as the 'master' branch, if possible. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "default branch" or `main` instead of `master`, when possible.' +message: "Use 'default branch' or `main` instead of `master`, when possible." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#default-branch scope: raw raw: - '\`master\`' diff --git a/doc/.vale/gitlab/Dropdown.yml b/doc/.vale/gitlab/Dropdown.yml index 6163e765989..e756d45120d 100644 --- a/doc/.vale/gitlab/Dropdown.yml +++ b/doc/.vale/gitlab/Dropdown.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use "dropdown list".' +message: "Use 'dropdown list'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#dropdown-list level: suggestion ignorecase: true diff --git a/doc/.vale/gitlab/EOLWhitespace.yml b/doc/.vale/gitlab/EOLWhitespace.yml index 64f505b2bae..153786443cc 100644 --- a/doc/.vale/gitlab/EOLWhitespace.yml +++ b/doc/.vale/gitlab/EOLWhitespace.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Lines should not end with whitespace characters.' +message: "Remove whitespace characters from the end of the line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: warning scope: raw diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index 06121492e99..f3573f5ce65 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'When describing elements, %s "%s".' +message: "When describing elements, %s '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: suggestion ignorecase: true diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index ab7855a78db..e97b886b5ed 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -5,10 +5,10 @@ # # 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.' +message: "Instead of '%s', speak directly to the reader. Use 'you' or re-write to remove." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html tokens: - '\bI[ ,;:?!"]|\bI\x27.{1,2}' - me diff --git a/doc/.vale/gitlab/FutureTense.yml b/doc/.vale/gitlab/FutureTense.yml index 0809f5f9063..d1484b20008 100644 --- a/doc/.vale/gitlab/FutureTense.yml +++ b/doc/.vale/gitlab/FutureTense.yml @@ -5,10 +5,10 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Avoid using future tense: "%s". Use present tense instead.' +message: "Instead of future tense '%s', use present tense." ignorecase: true level: warning -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#future-tense raw: - "(going to( |\n|[[:punct:]])[a-zA-Z]*|" - "will( |\n|[[:punct:]])[a-zA-Z]*|" diff --git a/doc/.vale/gitlab/HeadingContent.yml b/doc/.vale/gitlab/HeadingContent.yml index 50af625ce19..31ac3022934 100644 --- a/doc/.vale/gitlab/HeadingContent.yml +++ b/doc/.vale/gitlab/HeadingContent.yml @@ -5,10 +5,10 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Rename the subheading "%s", or re-purpose the content elsewhere.' +message: "Rename the heading '%s', or re-purpose the content elsewhere." level: warning scope: heading -link: https://docs.gitlab.com/ee/development/documentation/styleguide/#headings-1 +link: https://docs.gitlab.com/ee/development/documentation/topic_types/concept.html#concept-headings ignorecase: false tokens: - How it works diff --git a/doc/.vale/gitlab/HeadingDepth.yml b/doc/.vale/gitlab/HeadingDepth.yml index 466ab317226..7a3e5b4b552 100644 --- a/doc/.vale/gitlab/HeadingDepth.yml +++ b/doc/.vale/gitlab/HeadingDepth.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'The subheading "%s" is nested too deeply. Headings deeper than H5 suggest the section or page should be refactored.' +message: "Refactor the section or page to avoid headings greater than H5." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#headings-in-markdown level: warning scope: raw diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 66d89a26717..7419430c8a2 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionCultural.yml b/doc/.vale/gitlab/InclusionCultural.yml index 94662d4bc42..6de838e7f25 100644 --- a/doc/.vale/gitlab/InclusionCultural.yml +++ b/doc/.vale/gitlab/InclusionCultural.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning ignorecase: true swap: diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index 62302d21ae7..ce8861b6a09 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use inclusive language. Consider "%s" instead of "%s".' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#inclusive-language +message: "Use inclusive language. Consider '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: diff --git a/doc/.vale/gitlab/InternalLinkCase.yml b/doc/.vale/gitlab/InternalLinkCase.yml index 45a0c88e47e..fded735812a 100644 --- a/doc/.vale/gitlab/InternalLinkCase.yml +++ b/doc/.vale/gitlab/InternalLinkCase.yml @@ -5,8 +5,8 @@ # # 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-within-the-same-repository +message: "Use lowercase for the anchor link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#anchor-links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index 5d5687966ee..364263f90c8 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -5,8 +5,8 @@ # # 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-within-the-same-repository +message: "Link to a file and use the .md file extension instead of .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/InternalLinkFormat.yml b/doc/.vale/gitlab/InternalLinkFormat.yml index 08b48f9e3e5..be09a020846 100644 --- a/doc/.vale/gitlab/InternalLinkFormat.yml +++ b/doc/.vale/gitlab/InternalLinkFormat.yml @@ -1,12 +1,12 @@ --- # Error: gitlab.InternalLinkFormat # -# Checks that internal link paths don't start with "./", which is not needed. +# Checks that internal link paths don't start with './', which is not needed. # # For a list of all options, see https://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-within-the-same-repository +message: "Edit the link so it does not start with './'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 306ffb08355..0bac0448bb1 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s", but consider rewriting the sentence.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +message: "Use '%s' instead of '%s', but consider rewriting the sentence." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/Markdown_emoji.yml b/doc/.vale/gitlab/Markdown_emoji.yml index 2cb4f54859e..9873fb8becd 100644 --- a/doc/.vale/gitlab/Markdown_emoji.yml +++ b/doc/.vale/gitlab/Markdown_emoji.yml @@ -5,7 +5,7 @@ # # 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.' +message: "Replace '%s' with GitLab SVGs or Unicode emojis." link: https://docs.gitlab.com/ee/development/documentation/styleguide/#gitlab-svg-icons level: warning scope: text diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab/MeaningfulLinkWords.yml index c13ec2f0221..6fb41c7ce95 100644 --- a/doc/.vale/gitlab/MeaningfulLinkWords.yml +++ b/doc/.vale/gitlab/MeaningfulLinkWords.yml @@ -5,11 +5,11 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Improve SEO and accessibility by rewriting "%s" in the link text.' +message: "Improve SEO and accessibility by rewriting '%s' in the link text." level: warning scope: link ignorecase: true -link: https://about.gitlab.com/handbook/communication/#writing-style-guidelines +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#text-for-links tokens: - here - this page diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab/MergeConflictMarkers.yml index bbe01820a84..54e044f195d 100644 --- a/doc/.vale/gitlab/MergeConflictMarkers.yml +++ b/doc/.vale/gitlab/MergeConflictMarkers.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Merge conflict marker "%s" found.' +message: "Remove the merge conflict marker '%s'." link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request level: error scope: raw diff --git a/doc/.vale/gitlab/MultiLineLinks.yml b/doc/.vale/gitlab/MultiLineLinks.yml index 3e73306e97d..32fe38277dc 100644 --- a/doc/.vale/gitlab/MultiLineLinks.yml +++ b/doc/.vale/gitlab/MultiLineLinks.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be on a single line, even if very long.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put the full link on one line, even if the link is very long." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/NonStandardQuotes.yml b/doc/.vale/gitlab/NonStandardQuotes.yml index c214488dfc0..6161a4cc000 100644 --- a/doc/.vale/gitlab/NonStandardQuotes.yml +++ b/doc/.vale/gitlab/NonStandardQuotes.yml @@ -5,10 +5,10 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use standard single quotes or double quotes only. Do not use left or right quotes.' +message: "Use standard single quotes or double quotes only. Do not use left or right quotes." level: warning ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation scope: raw raw: - '[‘’“”]' diff --git a/doc/.vale/gitlab/OutdatedVersions.yml b/doc/.vale/gitlab/OutdatedVersions.yml index b469304977e..10fbaa0a676 100644 --- a/doc/.vale/gitlab/OutdatedVersions.yml +++ b/doc/.vale/gitlab/OutdatedVersions.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Can this reference to "%s" be refactored?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#gitlab-versions +message: "If possible, remove the reference to '%s'." +link: https://docs.gitlab.com/ee/development/documentation/versions.html level: suggestion nonword: true ignorecase: true diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 814b0157699..81a9ae5c1fc 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Use a comma before the last "and" or "or" in a list of four or more items.' +message: "Use a comma before the last 'and' or 'or' in a list of four or more items." link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: warning raw: diff --git a/doc/.vale/gitlab/Possessive.yml b/doc/.vale/gitlab/Possessive.yml index 8f4f93ab93c..64c9481ac28 100644 --- a/doc/.vale/gitlab/Possessive.yml +++ b/doc/.vale/gitlab/Possessive.yml @@ -5,9 +5,9 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: "Rewrite '%s' to not use 's." +message: "Remove 's from %s." level: error ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#trademark +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#gitlab tokens: - GitLab's diff --git a/doc/.vale/gitlab/ReadingLevel.yml b/doc/.vale/gitlab/ReadingLevel.yml index ca3ddea46bf..a1ddebec1ea 100644 --- a/doc/.vale/gitlab/ReadingLevel.yml +++ b/doc/.vale/gitlab/ReadingLevel.yml @@ -7,7 +7,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: metric -message: "The grade level - %s - refers to how hard the content is to understand. Aim for 8th grade or lower by using shorter sentences and words." +message: "The grade level is %s. Aim for 8th grade or lower by using shorter sentences and words." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-readability-score level: suggestion formula: | diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index cc6f0c0a467..d9f20fa1bd6 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -5,8 +5,8 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Link "%s" must be inline.' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#basic-link-criteria +message: "Put this link inline with the rest of the text." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index 015e226ca39..6d46e432e08 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -5,8 +5,8 @@ # # 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-within-the-same-repository +message: "Use a relative link instead of a URL, and ensure the file name ends in .md and not .html." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml index 6f54ecbabc2..6a94c7f927a 100644 --- a/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml +++ b/doc/.vale/gitlab/RelativeLinksDoubleSlashes.yml @@ -5,8 +5,8 @@ # # 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-within-the-same-repository +message: "Remove the double slash from this relative link." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#links level: error scope: raw raw: diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab/Repetition.yml index 8f9d482b22b..cdeb29e7d45 100644 --- a/doc/.vale/gitlab/Repetition.yml +++ b/doc/.vale/gitlab/Repetition.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: repetition -message: '"%s" is repeated.' +message: "Remove this duplicate word: '%s'." level: error alpha: true tokens: diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml index 394bcbf3c70..69b0d27072e 100644 --- a/doc/.vale/gitlab/SentenceLength.yml +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: occurrence -message: 'Shorter sentences improve readability (max 25 words).' +message: "Improve readability by using fewer than 25 words in this sentence." scope: sentence link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language level: warning diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index 8589f0ffa9b..9ca685b00b8 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: '"%s" must contain one and only one space.' +message: "Remove the extra space: '%s'" link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#punctuation level: error nonword: true diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index 86f38045bc0..89169c1aa46 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -5,10 +5,10 @@ # # 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.' +message: "Remove '%s'. Be precise instead of subjective." level: suggestion ignorecase: true -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#usage-list +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html tokens: - easy - easily diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 5ea813d62b0..92c5cb13b29 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -10,7 +10,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: spelling -message: 'Spelling check: "%s"?' +message: "Check the spelling of '%s'. If the spelling is correct, add this word to the spelling exception list." level: warning ignore: - gitlab/spelling-exceptions.txt diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index 164ea5a32b6..21cabf1e0a7 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -6,24 +6,24 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Consider %s instead of "%s".' +message: "Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true swap: - active user: '"billable user"' - active users: '"billable users"' - docs: '"documentation"' - e-mail: '"email"' - GLFM: '"GitLab Flavored Markdown"' - it is recommended: '"you should"' - we recommend: '"you should"' + active user: "billable user" + active users: "billable users" + docs: "documentation" + e-mail: "email" + GLFM: "GitLab Flavored Markdown" + it is recommended: "you should" + we recommend: "you should" navigate: go - OAuth2: '"OAuth 2.0"' - once that: '"after that"' - once the: '"after the"' - once you: '"after you"' - since: '"because" or "after"' - sub-group: '"subgroup"' - sub-groups: '"subgroups"' - within: '"in"' + OAuth2: "OAuth 2.0" + once that: "after that" + once the: "after the" + once you: "after you" + since: "because' or 'after" + sub-group: "subgroup" + sub-groups: "subgroups" + within: "in" diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 65e4e7dacb2..34419d08fe8 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -6,7 +6,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'If possible, use "%s" instead of "%s".' +message: "If possible, use '%s' instead of '%s'." link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: warning ignorecase: true diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index cc299665331..92791486491 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -6,7 +6,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: 'Use "%s" instead of "%s".' +message: "Use '%s' instead of '%s'." link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true diff --git a/doc/.vale/gitlab/ToDo.yml b/doc/.vale/gitlab/ToDo.yml index 7781097c938..079f13baa28 100644 --- a/doc/.vale/gitlab/ToDo.yml +++ b/doc/.vale/gitlab/ToDo.yml @@ -5,8 +5,8 @@ # # 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 +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/word_list.html#to-do-item level: warning ignorecase: false swap: diff --git a/doc/.vale/gitlab/UnclearAntecedent.yml b/doc/.vale/gitlab/UnclearAntecedent.yml index 36de9fa532b..e5d43b6ab7d 100644 --- a/doc/.vale/gitlab/UnclearAntecedent.yml +++ b/doc/.vale/gitlab/UnclearAntecedent.yml @@ -5,7 +5,7 @@ # # 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." +message: "Instead of '%s', try starting this sentence with a specific subject and verb." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#this-these-that-those level: warning ignorecase: false diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index d966d7d3001..179df5532ca 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -5,7 +5,7 @@ # # 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." +message: "Instead of uppercase for '%s', use lowercase or backticks (`) if possible. Otherwise, add this word or acronym to the rule's exception list." link: https://docs.gitlab.com/ee/development/documentation/testing.html#vale-uppercase-acronym-test level: warning ignorecase: false diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index 6afce45e6d6..4fd80bc3f4e 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -11,7 +11,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'This introduced-in section is not formatted correctly. Each entry must start with `> -` and long entries must be on one line.' +message: "Start each entry with `> -`. Keep long entries on one line." link: https://docs.gitlab.com/ee/development/documentation/versions.html level: error scope: raw diff --git a/doc/.vale/gitlab/VersionTextSingleLine.yml b/doc/.vale/gitlab/VersionTextSingleLine.yml index e1f045efbd9..552ccb9951e 100644 --- a/doc/.vale/gitlab/VersionTextSingleLine.yml +++ b/doc/.vale/gitlab/VersionTextSingleLine.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence -message: 'Version text with only a single item must not start with a hyphen.' +message: "Do not use a hyphen '-' in version text if there is only a single item." link: https://docs.gitlab.com/ee/development/documentation/versions.html#add-a-version-history-item level: error scope: raw diff --git a/doc/.vale/gitlab/Wordy.yml b/doc/.vale/gitlab/Wordy.yml index 047df02adce..8fe8a12f161 100644 --- a/doc/.vale/gitlab/Wordy.yml +++ b/doc/.vale/gitlab/Wordy.yml @@ -5,7 +5,7 @@ # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution -message: '%s "%s".' +message: "%s '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: suggestion ignorecase: true diff --git a/doc/.vale/vale-json.tmpl b/doc/.vale/vale-json.tmpl index ed3c3259df3..f76ca03964c 100644 --- a/doc/.vale/vale-json.tmpl +++ b/doc/.vale/vale-json.tmpl @@ -21,13 +21,13 @@ {{- $error := "" -}} {{- if eq .Severity "error" -}} - {{- $error = .Severity -}} + {{- $error = "blocker" -}} {{- $e = add1 $e -}} {{- else if eq .Severity "warning" -}} - {{- $error = .Severity -}} + {{- $error = "major" -}} {{- $w = add1 $w -}} {{- else -}} - {{- $error = .Severity -}} + {{- $error ="info" -}} {{- $s = add1 $s -}} {{- end}} diff --git a/doc/administration/environment_variables.md b/doc/administration/environment_variables.md index beaef7afe57..d2edc3085f1 100644 --- a/doc/administration/environment_variables.md +++ b/doc/administration/environment_variables.md @@ -50,5 +50,5 @@ To set environment variables, follow [these instructions](https://docs.gitlab.co It's possible to preconfigure the GitLab Docker image by adding the environment variable `GITLAB_OMNIBUS_CONFIG` to the `docker run` command. -For more information, see the [Pre-configure Docker container](https://docs.gitlab.com/omnibus/docker/#pre-configure-docker-container) +For more information, see the [Pre-configure Docker container](../install/docker.md#pre-configure-docker-container) section of the Omnibus GitLab documentation. diff --git a/doc/administration/git_protocol.md b/doc/administration/git_protocol.md index f900c5a6867..7a7f8229f4b 100644 --- a/doc/administration/git_protocol.md +++ b/doc/administration/git_protocol.md @@ -25,7 +25,7 @@ From the server side, if we want to configure SSH we need to set the `sshd` server to accept the `GIT_PROTOCOL` environment. In installations using [GitLab Helm Charts](https://docs.gitlab.com/charts/) -and [All-in-one Docker image](https://docs.gitlab.com/omnibus/docker/), the SSH +and [All-in-one Docker image](../install/docker.md), the SSH service is already configured to accept the `GIT_PROTOCOL` environment. Users need not do anything more. diff --git a/doc/administration/object_storage.md b/doc/administration/object_storage.md index 6233aa217bd..f4741068584 100644 --- a/doc/administration/object_storage.md +++ b/doc/administration/object_storage.md @@ -18,7 +18,7 @@ GitLab has been tested by vendors and customers on a number of object storage pr - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatible mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - [Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) - On-premises hardware and appliances from various storage vendors, whose list is not officially established. diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index 45939b48f78..ce019976049 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -2155,7 +2155,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index 7d67ac48b73..fba5e5ec6ae 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -2159,7 +2159,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index 3f85fc5fd33..26a8d0e038a 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -878,7 +878,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - [Azure Blob storage](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blobs-introduction) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 7484fafe1b0..1ce19877580 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -2112,7 +2112,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/reference_architectures/50k_users.md b/doc/administration/reference_architectures/50k_users.md index 88fc3649b3f..b87af8b27ac 100644 --- a/doc/administration/reference_architectures/50k_users.md +++ b/doc/administration/reference_architectures/50k_users.md @@ -2176,7 +2176,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index c8cf35a2e59..510fa7c99b7 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -2111,7 +2111,7 @@ GitLab has been tested on a number of object storage providers: - [Amazon S3](https://aws.amazon.com/s3/) - [Google Cloud Storage](https://cloud.google.com/storage) - [Digital Ocean Spaces](https://www.digitalocean.com/products/spaces) -- [Oracle Cloud Infrastructure](https://docs.cloud.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) +- [Oracle Cloud Infrastructure](https://docs.oracle.com/en-us/iaas/Content/Object/Tasks/s3compatibleapi.htm) - [OpenStack Swift (S3 compatibility mode)](https://docs.openstack.org/swift/latest/s3_compat.html) - MinIO. We have [a guide to deploying this](https://docs.gitlab.com/charts/advanced/external-object-storage/minio.html) within our Helm Chart documentation. diff --git a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md index 193f58fa5d3..d87d2a1c55d 100644 --- a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md +++ b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md @@ -308,24 +308,3 @@ Moved to [Geo replication troubleshooting](../geo/replication/troubleshooting.md ## Generate Service Ping This content has been moved to [Service Ping Troubleshooting](../../development/service_ping/troubleshooting.md). - -## GraphQL - -Call a [GraphQL](../../api/graphql/getting_started.md) endpoint through the Rails console: - -```ruby -query = <<~EOQ -query securityGetProjects($search: String!) { - projects(search: $search) { - nodes { - path - } - } -} -EOQ - -variables = { "search": "gitlab" } - -result = GitlabSchema.execute(query, variables: variables, context: { current_user: current_user }) -result.to_h -``` diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index 20fb2f030f2..1945f528d67 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -18,6 +18,7 @@ The examples documented here can be run using: - The command line. - GraphiQL. +- Rails console. ### Command line @@ -73,6 +74,27 @@ NOTE: If you are running GitLab 12.0, enable the `graphql` [feature flag](../features.md#set-or-create-a-feature). +### Rails console **(FREE SELF)** + +GraphQL queries can be run in a [Rails console session](../../administration/operations/rails_console.md#starting-a-rails-console-session). For example, to search projects: + +```ruby +query = <<~EOQ +query securityGetProjects($search: String!) { + projects(search: $search) { + nodes { + path + } + } +} +EOQ + +variables = { "search": "gitlab" } + +result = GitlabSchema.execute(query, variables: variables, context: { current_user: current_user }) +result.to_h +``` + ## Queries and mutations The GitLab GraphQL API can be used to perform: diff --git a/doc/ci/docker/using_docker_build.md b/doc/ci/docker/using_docker_build.md index 06197d71690..43e537ee683 100644 --- a/doc/ci/docker/using_docker_build.md +++ b/doc/ci/docker/using_docker_build.md @@ -47,7 +47,7 @@ the Docker commands, but needs permission to do so. ``` 1. On the server where GitLab Runner is installed, install Docker Engine. - View a list of [supported platforms](https://docs.docker.com/engine/installation/). + View a list of [supported platforms](https://docs.docker.com/engine/install/). 1. Add the `gitlab-runner` user to the `docker` group: diff --git a/doc/ci/docker/using_docker_images.md b/doc/ci/docker/using_docker_images.md index 70680a44ed2..0ba510acdbc 100644 --- a/doc/ci/docker/using_docker_images.md +++ b/doc/ci/docker/using_docker_images.md @@ -64,7 +64,7 @@ For example, you can set the [Docker pull policy](https://docs.gitlab.com/runner to use local images. For more information about images and Docker Hub, see -the [Docker Fundamentals](https://docs.docker.com/engine/understanding-docker/) documentation. +the [Docker overview](https://docs.docker.com/get-started/overview/). ## Define `image` in the `.gitlab-ci.yml` file diff --git a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md index 6c67d7ab212..28016216dbb 100644 --- a/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md +++ b/doc/ci/examples/laravel_with_gitlab_and_envoy/index.md @@ -444,7 +444,7 @@ On your GitLab project repository navigate to the **Registry** tab. You may need to enable the Container Registry for your project to see this tab. You'll find it under your project's **Settings > General > Visibility, project features, permissions**. To start using Container Registry on our machine, we first need to sign in to the GitLab registry using our GitLab username and password. -Make sure you have [Docker](https://docs.docker.com/engine/installation/) installed on our machine, +Make sure you have [Docker](https://docs.docker.com/engine/install/) installed on our machine, then run the following commands: ```shell diff --git a/doc/development/documentation/site_architecture/deployment_process.md b/doc/development/documentation/site_architecture/deployment_process.md index 959c6a22777..18cc27adaaa 100644 --- a/doc/development/documentation/site_architecture/deployment_process.md +++ b/doc/development/documentation/site_architecture/deployment_process.md @@ -182,7 +182,7 @@ Dockerfiles to build and deploy <https://docs.gitlab.com>. It is heavily inspire Although build images are built automatically via GitLab CI/CD, you can build and tag all tooling images locally: -1. Make sure you have [Docker installed](https://docs.docker.com/install/). +1. Make sure you have [Docker installed](https://docs.docker.com/get-docker/). 1. Make sure you're in the `dockerfiles/` directory of the `gitlab-docs` repository. 1. Build the images: diff --git a/doc/development/go_guide/index.md b/doc/development/go_guide/index.md index 197c7616d82..b561ebc4285 100644 --- a/doc/development/go_guide/index.md +++ b/doc/development/go_guide/index.md @@ -408,7 +408,7 @@ should be used in functions that can block and passed as the first parameter. Every project should have a `Dockerfile` at the root of their repository, to build and run the project. Since Go program are static binaries, they should not require any external dependency, and shells in the final image are useless. -We encourage [Multistage builds](https://docs.docker.com/develop/develop-images/multistage-build/): +We encourage [Multistage builds](https://docs.docker.com/build/building/multi-stage/): - They let the user build the project with the right Go version and dependencies. diff --git a/doc/development/integrations/secure.md b/doc/development/integrations/secure.md index f40caf29cfa..faba5e3540e 100644 --- a/doc/development/integrations/secure.md +++ b/doc/development/integrations/secure.md @@ -157,7 +157,7 @@ If the scanner requires a fully functional Linux environment, it is recommended to use a [Debian](https://www.debian.org/intro/about) "slim" distribution or [Alpine Linux](https://www.alpinelinux.org/). If possible, it is recommended to build the image from scratch, using the `FROM scratch` instruction, and to compile the scanner with all the libraries it needs. -[Multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/) +[Multi-stage builds](https://docs.docker.com/build/building/multi-stage/) might also help with keeping the image small. To keep an image size small, consider using [dive](https://github.com/wagoodman/dive#dive) to analyze layers in a Docker image to diff --git a/doc/development/service_ping/implement.md b/doc/development/service_ping/implement.md index 8ab7786f012..48992256ae4 100644 --- a/doc/development/service_ping/implement.md +++ b/doc/development/service_ping/implement.md @@ -813,7 +813,7 @@ and run a local container instance: 1. On your local machine, make sure you are signed in to the GitLab Docker registry. You can find the instructions for this in [Authenticate to the GitLab Container Registry](../../user/packages/container_registry/index.md#authenticate-with-the-container-registry). 1. Once signed in, download the new image by using `docker pull registry.gitlab.com/gitlab-org/build/omnibus-gitlab-mirror/gitlab-ee:<VERSION>` -1. For more information about working with and running Omnibus GitLab containers in Docker, refer to [GitLab Docker images](https://docs.gitlab.com/omnibus/docker/README.html) in the Omnibus documentation. +1. For more information about working with and running Omnibus GitLab containers in Docker, refer to [GitLab Docker images](../../install/docker.md) documentation. ### Test with GitLab development toolkits diff --git a/doc/install/docker.md b/doc/install/docker.md index 93988454a27..22a6a2d8086 100644 --- a/doc/install/docker.md +++ b/doc/install/docker.md @@ -31,7 +31,7 @@ to community resources (such as IRC or forums) to seek help from other users. ## Prerequisites -Docker is required. See the [official installation documentation](https://docs.docker.com/install/). +Docker is required. See the [official installation documentation](https://docs.docker.com/get-docker/). ## Set up the volumes location diff --git a/doc/raketasks/backup_gitlab.md b/doc/raketasks/backup_gitlab.md index da004a1b774..47696fc1f99 100644 --- a/doc/raketasks/backup_gitlab.md +++ b/doc/raketasks/backup_gitlab.md @@ -139,7 +139,7 @@ For installation from source: - `/home/git/gitlab/config/secrets.yml` - `/home/git/gitlab/config/gitlab.yml` -For [Docker installations](https://docs.gitlab.com/omnibus/docker/), you must +For [Docker installations](../install/docker.md), you must back up the volume where the configuration files are stored. If you created the GitLab container according to the documentation, it should be in the `/srv/gitlab/config` directory. diff --git a/doc/user/packages/container_registry/index.md b/doc/user/packages/container_registry/index.md index 970f2e9b3cc..779af944674 100644 --- a/doc/user/packages/container_registry/index.md +++ b/doc/user/packages/container_registry/index.md @@ -70,7 +70,7 @@ To download and run a container image hosted in the GitLab Container Registry: [Authentication](#authenticate-with-the-container-registry) is needed to download images from private repository. For more information on running Docker containers, visit the -[Docker documentation](https://docs.docker.com/engine/userguide/intro/). +[Docker documentation](https://docs.docker.com/get-started/). ## Image naming convention diff --git a/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md b/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md index 459c759abe6..74cbcba2ffc 100644 --- a/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md +++ b/doc/user/packages/container_registry/reduce_container_registry_data_transfer.md @@ -90,7 +90,7 @@ build process instead of trying to minify images afterward. ### Use multi-stage builds -With [multi-stage builds](https://docs.docker.com/develop/develop-images/multistage-build/), +With [multi-stage builds](https://docs.docker.com/build/building/multi-stage/), you use multiple `FROM` statements in your Dockerfile. Each `FROM` instruction can use a different base, and each begins a new build stage. You can selectively copy artifacts from one stage to another, leaving behind everything you don't want in the final image. This is especially useful when |