Add latest changes from gitlab-org/gitlab@master

8 files changed, 144 insertions, 0 deletions

diff --git a/doc/.vale/gitlab/Contractions.yml b/doc/.vale/gitlab/Contractions.yml
new file mode 100644
index 00000000000..5f389bd1ea4
--- /dev/null
+++ b/doc/.vale/gitlab/Contractions.yml
@@ -0,0 +1,53 @@
+---
+# Checks for use of common and uncommon contractions.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: substitution
+message: Use "%s" instead of "%s" in most cases.
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
+level: suggestion
+nonword: false
+ignorecase: true
+swap:
+
+  # Common contractions are ok
+  it is: it's
+  can not: can't
+  cannot: can't
+  do not: don't
+  have not: haven't
+  that is: that's
+  we are: we're
+  will not: won't
+  would not: wouldn't
+  you are: you're
+  you have: you've
+
+  # Uncommon contractions are not ok
+  aren't: are not
+  couldn't: could not
+  didn't: did not
+  doesn't: does not
+  hasn't: has not
+  how'll: how will
+  how's: how is
+  isn't: is not
+  it'll: it will
+  shouldn't: should not
+  that'll: that will
+  they'll: they will
+  they're: they are
+  wasn't: was not
+  weren't: were not
+  we'll: we will
+  we've: we have
+  what's: what is
+  what'll: what will
+  when's: when is
+  when'll: when will
+  where's: where is
+  where'll: where will
+  who's: who is
+  who'll: who will
+  why's: why is
+  why'll: why will
diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml
new file mode 100644
index 00000000000..18c5265b0a6
--- /dev/null
+++ b/doc/.vale/gitlab/FirstPerson.yml
@@ -0,0 +1,13 @@
+# Checks for use of first person pronouns.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: '`%s` is a first-person pronoun. Use second- or third-person pronouns (like we, you, us, one) instead.'
+level: warning
+ignorecase: true
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
+tokens:
+  - '\bI[ ,;:?!"]|\bI\x27.{1,2}'
+  - me
+  - myself
+  - mine
diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml
new file mode 100644
index 00000000000..d07a2600798
--- /dev/null
+++ b/doc/.vale/gitlab/InternalLinkExtension.yml
@@ -0,0 +1,11 @@
+---
+# Checks that internal links have .md extenstion and not .html extension.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: Link %s must use the .md file extension.
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
+level: error
+scope: raw
+raw:
+  - '\[.+\]\((https?:){0}[\w\/\.-]+(\.html).*\)'
diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml
new file mode 100644
index 00000000000..8412631f8fe
--- /dev/null
+++ b/doc/.vale/gitlab/LatinTerms.yml
@@ -0,0 +1,17 @@
+---
+# Checks for use of latin terms..
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: substitution
+message: Use "%s" instead of "%s," but consider rewriting the sentence.
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language
+level: warning
+nonword: true
+ignorecase: true
+swap:
+  e\.g\.: for example
+  e\. g\.: for example
+  i\.e\.: that is
+  i\. e\.: that is
+  etc\.: and so on
+  et cetera: and so on
diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml
new file mode 100644
index 00000000000..4b37ba8c2b9
--- /dev/null
+++ b/doc/.vale/gitlab/OxfordComma.yml
@@ -0,0 +1,11 @@
+---
+# 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.github.io/vale/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.html#punctuation
+level: warning
+raw:
+  - '(?:[\w-_` ]+,){2,}(?:[\w-_` ]+) (and |or )'
diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml
new file mode 100644
index 00000000000..95bd60dd6e4
--- /dev/null
+++ b/doc/.vale/gitlab/RelativeLinks.yml
@@ -0,0 +1,11 @@
+---
+# Checks for the presence of absolute hyperlinks that should be relative.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: Link %s must be relative.
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation
+level: error
+scope: raw
+raw:
+  - '\[.+\]\(https?:\/\/docs\.gitlab\.com\/ee.*\)'
diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml
new file mode 100644
index 00000000000..b061f7f6f9e
--- /dev/null
+++ b/doc/.vale/gitlab/SentenceSpacing.yml
@@ -0,0 +1,15 @@
+---
+# Check for the following in common content scenarios:
+#
+# - No spaces.
+# - More than one space.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: existence
+message: '"%s" must contain one and only one space.'
+link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#punctuation
+level: error
+nonword: true
+tokens:
+  - '[a-z][.?!,][A-Z]'
+  - '[\w.?!,\(\)\-":] {2,}[\w.?!,\(\)\-":]'
diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml
new file mode 100644
index 00000000000..b32a03e17d5
--- /dev/null
+++ b/doc/.vale/gitlab/Substitutions.yml
@@ -0,0 +1,13 @@
+---
+# Checks for use of some of the top misused terms at GitLab.
+#
+# For a list of all options, see https://errata-ai.github.io/vale/styles/
+extends: substitution
+message: Use "%s" instead of "%s".
+link: https://about.gitlab.com/handbook/communication/#top-misused-terms
+level: error
+ignorecase: true
+swap:
+  GitLabber: GitLab team member
+  self hosted: self-managed
+  self-hosted: self-managed