diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-06-18 11:18:50 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-06-18 11:18:50 +0000 |
commit | 8c7f4e9d5f36cff46365a7f8c4b9c21578c1e781 (patch) | |
tree | a77e7fe7a93de11213032ed4ab1f33a3db51b738 /doc/.vale/gitlab | |
parent | 00b35af3db1abfe813a778f643dad221aad51fca (diff) | |
download | gitlab-ce-8c7f4e9d5f36cff46365a7f8c4b9c21578c1e781.tar.gz |
Add latest changes from gitlab-org/gitlab@13-1-stable-ee
Diffstat (limited to 'doc/.vale/gitlab')
23 files changed, 318 insertions, 47 deletions
diff --git a/doc/.vale/gitlab/Acronyms.yml b/doc/.vale/gitlab/Acronyms.yml new file mode 100644 index 00000000000..5176a18e2b6 --- /dev/null +++ b/doc/.vale/gitlab/Acronyms.yml @@ -0,0 +1,71 @@ +--- +# Warning: gitlab.Acronyms +# +# Checks for unexpanded acronyms. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: conditional +message: '"%s" has no definition.' +link: https://about.gitlab.com/handbook/marketing/growth-marketing/content/editorial-team/#acronyms +level: warning +ignorecase: false +# Ensures that the existence of 'first' implies the existence of 'second'. +first: '\b([A-Z]{3,5})\b' +second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)' +# ... with the exception of these: +exceptions: + - API + - ARN + - ASCII + - AWS + - CNAME + - CPU + - CSS + - CSV + - DNS + - EKS + - GDK + - GET + - GNU + - GPG + - GPL + - HTML + - HTTP + - HTTPS + - IAM + - IDE + - JSON + - LDAP + - LDAPS + - LESS + - LFS + - NFS + - NGINX + - NOTE + - ONLY + - PGP + - PHP + - POST + - PUT + - RPC + - RSA + - RSS + - SAML + - SCP + - SCSS + - SHA + - SQL + - SSH + - SSL + - SSO + - TIP + - TLS + - TODO + - TOML + - UNIX + - URI + - URL + - VPC + - WIP + - XML + - YAML diff --git a/doc/.vale/gitlab/BadgeCapitalization.yml b/doc/.vale/gitlab/BadgeCapitalization.yml index 7e68a06b4d5..c9e9da3b6ce 100644 --- a/doc/.vale/gitlab/BadgeCapitalization.yml +++ b/doc/.vale/gitlab/BadgeCapitalization.yml @@ -1,5 +1,7 @@ --- -# Verifies that badges are not lower case, which won't render properly. +# Error: gitlab.BadgeCapitalization +# +# Verifies that badges are not mixed case, which won't render properly. # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: existence diff --git a/doc/.vale/gitlab/British.yml b/doc/.vale/gitlab/British.yml index 943e85beba1..1e5841d3648 100644 --- a/doc/.vale/gitlab/British.yml +++ b/doc/.vale/gitlab/British.yml @@ -1,9 +1,11 @@ --- -# Checks for use of some of the top misused terms at GitLab. +# Error: gitlab.British +# +# Checks that US spelling is used over British spelling. # # For a list of all options, see https://errata-ai.github.io/vale/styles/ extends: substitution -message: 'Use the American spelling "%s" instead of the British "%s".' +message: 'Use the US spelling "%s" instead of the British "%s".' link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true diff --git a/doc/.vale/gitlab/CodeblockFences.yml b/doc/.vale/gitlab/CodeblockFences.yml new file mode 100644 index 00000000000..8b61a1a3c16 --- /dev/null +++ b/doc/.vale/gitlab/CodeblockFences.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.CodeblockFences +# +# Ensures all codeblock language tags use the full name, not aliases. +# +# For a list of all options, see https://errata-ai.github.io/vale/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.html#code-blocks +level: error +scope: raw +raw: + - '\`\`\`(yml|rb|text|md|bash|sh\n|js\n|go\n|py\n|docker\n|ts)' diff --git a/doc/.vale/gitlab/Contractions.yml b/doc/.vale/gitlab/Contractions.yml index f4ec24742da..45212945c53 100644 --- a/doc/.vale/gitlab/Contractions.yml +++ b/doc/.vale/gitlab/Contractions.yml @@ -1,9 +1,11 @@ --- +# Suggestion: gitlab.Contractions +# # 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", for a friendly, informal tone. +message: 'Use "%s" instead of "%s", for a friendly, informal tone.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language level: suggestion nonword: false diff --git a/doc/.vale/gitlab/CurlStringsQuoted.yml b/doc/.vale/gitlab/CurlStringsQuoted.yml new file mode 100644 index 00000000000..4fcb0069423 --- /dev/null +++ b/doc/.vale/gitlab/CurlStringsQuoted.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.CurlStringsQuoted +# +# Ensures all codeblocks using curl quote any URL strings. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +message: 'Curl commands must wrap URLs in double quotes ("): %s' +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#curl-commands +level: warning +scope: code +raw: + - 'curl.*[^"=]https?://.*' diff --git a/doc/.vale/gitlab/FirstPerson.yml b/doc/.vale/gitlab/FirstPerson.yml index 18c5265b0a6..6db89dd4758 100644 --- a/doc/.vale/gitlab/FirstPerson.yml +++ b/doc/.vale/gitlab/FirstPerson.yml @@ -1,8 +1,11 @@ +--- +# Warning: gitlab.FirstPerson +# # 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.' +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 diff --git a/doc/.vale/gitlab/InternalLinkExtension.yml b/doc/.vale/gitlab/InternalLinkExtension.yml index d07a2600798..94a935196a7 100644 --- a/doc/.vale/gitlab/InternalLinkExtension.yml +++ b/doc/.vale/gitlab/InternalLinkExtension.yml @@ -1,9 +1,11 @@ --- +# Error: gitlab.InternalLinkExtension +# # 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. +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 diff --git a/doc/.vale/gitlab/LatinTerms.yml b/doc/.vale/gitlab/LatinTerms.yml index 8412631f8fe..a2d024fb1ec 100644 --- a/doc/.vale/gitlab/LatinTerms.yml +++ b/doc/.vale/gitlab/LatinTerms.yml @@ -1,9 +1,11 @@ --- -# Checks for use of latin terms.. +# Warning: gitlab.LatinTerms +# +# 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. +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 diff --git a/doc/.vale/gitlab/MeaningfulLinkWords.yml b/doc/.vale/gitlab/MeaningfulLinkWords.yml new file mode 100644 index 00000000000..1931112ab3e --- /dev/null +++ b/doc/.vale/gitlab/MeaningfulLinkWords.yml @@ -0,0 +1,15 @@ +--- +# Warning: gitlab.MeaningfulLinkWords +# +# Checks for the presence of semantically unhelpful words in link text. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +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 +tokens: + - here + - this page diff --git a/doc/.vale/gitlab/MergeConflictMarkers.yml b/doc/.vale/gitlab/MergeConflictMarkers.yml new file mode 100644 index 00000000000..4d733c856e5 --- /dev/null +++ b/doc/.vale/gitlab/MergeConflictMarkers.yml @@ -0,0 +1,13 @@ +--- +# Error: gitlab.MergeConflictMarkers +# +# Checks for the presence of merge conflict markers. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: existence +message: 'Merge conflict marker "%s" found.' +link: https://docs.gitlab.com/ee/development/code_review.html#merging-a-merge-request +level: error +scope: raw +raw: + - '\n<<<<<<< .+\n|\n=======\n|\n>>>>>>> .+\n' diff --git a/doc/.vale/gitlab/OxfordComma.yml b/doc/.vale/gitlab/OxfordComma.yml index 4b37ba8c2b9..e04d209d960 100644 --- a/doc/.vale/gitlab/OxfordComma.yml +++ b/doc/.vale/gitlab/OxfordComma.yml @@ -1,10 +1,12 @@ --- +# Warning: gitlab.OxfordComma +# # 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. +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: diff --git a/doc/.vale/gitlab/Profanity.yml b/doc/.vale/gitlab/Profanity.yml deleted file mode 100644 index c386b23e52c..00000000000 --- a/doc/.vale/gitlab/Profanity.yml +++ /dev/null @@ -1,30 +0,0 @@ ---- -extends: existence -message: "Remove profanity: '%s'" -ignorecase: true -level: error -tokens: - - 'arse(hole)?' - - 'ass(hole)?' - - 'bastard' - - 'bitch' - - 'bloody' - - 'bollocks' - - 'bugger' - - 'cocksucker' - - 'crap' - - 'cunt' - - 'damn' - - 'eff(ing)?' - - 'fart' - - 'fuck(er|ing)?' - - 'goddamn(it?|ed)' - - 'hell' - - 'horseshit' - - 'motherfuck(ers?|ing)' - - 'piss(ing)?' - - 'shit' - - 'tits' - - 'turd' - - 'twat' - - 'wank(er|ing)?' diff --git a/doc/.vale/gitlab/ReferenceLinks.yml b/doc/.vale/gitlab/ReferenceLinks.yml index 35a657710de..8a3b6940187 100644 --- a/doc/.vale/gitlab/ReferenceLinks.yml +++ b/doc/.vale/gitlab/ReferenceLinks.yml @@ -1,3 +1,6 @@ +--- +# Error: gitlab.ReferenceLinks +# # Checks for the presence of reference-style links that must be inline. # # For a list of all options, see https://errata-ai.github.io/vale/styles/ diff --git a/doc/.vale/gitlab/RelativeLinks.yml b/doc/.vale/gitlab/RelativeLinks.yml index 95bd60dd6e4..de24d0608e7 100644 --- a/doc/.vale/gitlab/RelativeLinks.yml +++ b/doc/.vale/gitlab/RelativeLinks.yml @@ -1,9 +1,11 @@ --- +# Error: gitlab.RelativeLinks +# # 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. +message: 'Link "%s" must be relative.' link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#links-to-internal-documentation level: error scope: raw diff --git a/doc/.vale/gitlab/Repetition.yml b/doc/.vale/gitlab/Repetition.yml index 8477a4feb58..76afb7bb5ab 100644 --- a/doc/.vale/gitlab/Repetition.yml +++ b/doc/.vale/gitlab/Repetition.yml @@ -1,3 +1,6 @@ +--- +# Error: gitlab.Repetition +# # Checks for duplicate words, like `the the` or `and and`. # # For a list of all options, see https://errata-ai.github.io/vale/styles/ diff --git a/doc/.vale/gitlab/SentenceLength.yml b/doc/.vale/gitlab/SentenceLength.yml new file mode 100644 index 00000000000..b19b76723a6 --- /dev/null +++ b/doc/.vale/gitlab/SentenceLength.yml @@ -0,0 +1,13 @@ +--- +# Warning: gitlab.SentenceLength +# +# Counts words in a sentence and alerts if a sentence exceeds 25 words. +# +# For a list of all options, see https://errata-ai.github.io/vale/styles/ +extends: occurrence +message: 'Shorter sentences improve readability (max 25 words).' +scope: sentence +link: https://docs.gitlab.com/ee/development/documentation/styleguide.html#language +level: warning +max: 25 +token: \b(\w+)\b diff --git a/doc/.vale/gitlab/SentenceSpacing.yml b/doc/.vale/gitlab/SentenceSpacing.yml index b061f7f6f9e..c460ef3ae65 100644 --- a/doc/.vale/gitlab/SentenceSpacing.yml +++ b/doc/.vale/gitlab/SentenceSpacing.yml @@ -1,4 +1,6 @@ --- +# Error: gitlab.SentenceSpacing +# # Check for the following in common content scenarios: # # - No spaces. diff --git a/doc/.vale/gitlab/Spelling.yml b/doc/.vale/gitlab/Spelling.yml index 9b9b1ef10c2..7bf0f085f5c 100644 --- a/doc/.vale/gitlab/Spelling.yml +++ b/doc/.vale/gitlab/Spelling.yml @@ -1,3 +1,6 @@ +--- +# Warning: gitlab.Spelling +# # Checks for possible spelling mistakes in content, not code. May find false positives # due to links using angle brackets: <https://example.com>. These can be ignored. # diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index fe690d708ed..8c5f7705417 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -1,4 +1,6 @@ --- +# Warning: gitlab.SubstitutionWarning +# # Warns against using common shorthand for terms. # For substitutions flagged as errors, see Substitutions.yml # @@ -10,7 +12,9 @@ level: warning ignorecase: true swap: admin: administrator + blacklist(ed|ing)?: denylist config: configuration distro: distribution info: information repo: repository + whitelist(ed|ing)?: allowlist diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index b9c0dbecf31..156ff3a53f0 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -1,4 +1,6 @@ --- +# Error: gitlab.Substitutions +# # Checks for use of some of the top misused terms at GitLab. # For substitutions only flagged as warnings, see SubstitutionWarning.yml # @@ -9,6 +11,7 @@ link: https://about.gitlab.com/handbook/communication/#top-misused-terms level: error ignorecase: true swap: + frontmatter: front matter GitLabber: GitLab team member gitlab omnibus: Omnibus GitLab param: parameter diff --git a/doc/.vale/gitlab/VersionText.yml b/doc/.vale/gitlab/VersionText.yml index c572a1a926c..9a05103cc39 100644 --- a/doc/.vale/gitlab/VersionText.yml +++ b/doc/.vale/gitlab/VersionText.yml @@ -1,4 +1,6 @@ --- +# Error: gitlab.VersionText +# # Checks that version text is formatted correctly. # # Specifically looks for either of the following that is immediately followed on the next line diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index c5e89f72043..b56fa2861ca 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -1,13 +1,20 @@ Akismet Alertmanager Algolia +Alibaba +allowlist +allowlisting +allowlists +anonymized Ansible Anthos API approvers +architected Artifactory Asana Asciidoctor +Assembla Atlassian Auth0 Authentiq @@ -25,7 +32,10 @@ autoscaler autoscales autoscaling awardable +Axios Azure +B-tree +backfilling backport backported backporting @@ -34,6 +44,7 @@ backtrace backtraced backtraces backtracing +badging Bamboo Bitbucket blockquote @@ -41,6 +52,7 @@ blockquoted blockquotes blockquoting boolean +Bootsnap browsable Bugzilla Buildkite @@ -52,8 +64,16 @@ burndown cacheable CAS CentOS -Chatops +Certbot +chai +chatbot +chatbots +ChatOps +checksummed +checksumming Citrix +Citus +clonable Cloudwatch Cobertura Cognito @@ -63,6 +83,7 @@ compilable composable Conda Consul +Corosync cron crons crontab @@ -72,41 +93,67 @@ crosslinking crosslinks Crossplane CrowdIn +Dangerfile +datetime Debian deduplicate deduplicated deduplicates deduplicating deduplication +deliverables +denylist +denylisting +denylists +deployer +deployers deprovision deprovisioned deprovisioning deprovisions +dequarantine +dequarantined +dequarantining +DevOps discoverability Disqus Dockerfile Dockerfiles +dogfood +dogfoods +dogfooding dotenv downvoted downvotes Dpl Dreamweaver +Ecto Elasticsearch enablement enqueued +enum +enums +ETag +Excon expirable Facebook failover failovers failsafe +fastlane favicon +Filebeat +Fio firewalled Flawfinder Flowdock Fluentd Forgerock +Fugit Gantt Gemnasium +Gemojione +gettext Git Gitaly Gitea @@ -115,6 +162,7 @@ GitLab gitlabsos Gitleaks Gitter +globals Gmail Google Gosec @@ -122,6 +170,7 @@ Gradle Grafana gravatar Gzip +Haml hardcode hardcoded hardcodes @@ -140,6 +189,7 @@ hotfixing http https idempotence +idmapper Ingress initializer initializers @@ -152,39 +202,56 @@ jasmine-jquery JavaScript Jaeger Jenkins +Jenkinsfile Jira jQuery +jsdom JupyterHub kanban kanbans +Kaniko Karma Kerberos Kibana +Kinesis Knative Kramdown +kubectl Kubernetes Kubesec Laravel LDAP +ldapsearch +Leiningen Libravatar Lograge +Logstash lookahead lookaheads lookbehind lookbehinds lookups +loopback Lucene Maildir +Mailgun Makefile Makefiles Markdown markdownlint +matcher +matchers Mattermost mbox +memoization +memoize +memoized +memoizing mergeable Microsoft middleware middlewares +migratus Minikube MinIO mitmproxy @@ -195,16 +262,24 @@ misconfiguration misconfigurations misconfiguring mitigations +mixin +mixins mockup mockups ModSecurity +monorepo +monorepos +mutex nameserver nameservers namespace namespaced namespaces +namespacing +namespacings Nanoc NGINX +Nokogiri npm Nurtch OAuth @@ -213,17 +288,24 @@ offboarded offboarding offboards OmniAuth +onboarding OpenID OpenShift Packagist parallelization parallelizations +passwordless +Patroni performant +phaser +phasers Pipfile Pipfiles Piwik PgBouncer plaintext +Poedit +pooler PostgreSQL precompile preconfigure @@ -233,8 +315,12 @@ prefill prefilled prefilling prefills +preload +preloading +preloads prepend prepended +prepending prepends Pritaly profiler @@ -242,8 +328,8 @@ Prometheus proxied proxies proxying -Pseudonymized -Pseudonymizer +pseudonymized +pseudonymizer Puma Python Qualys @@ -259,20 +345,27 @@ Redcarpet Redis Redmine reCAPTCHA +redirection +redirections +refactorings referer referers +reflog +reflogs reindex reindexed reindexes reindexing relicensing remediations -Repmgr -Repmgrd +repmgr +repmgrd +repurposing requeue requeued requeues reusability +Restlet resynced resyncing resyncs @@ -287,6 +380,8 @@ reverified reverifies reverify Rubix +Rubocop +Rubular runbook runbooks runit @@ -294,11 +389,15 @@ runtime runtimes Salesforce SAML +sandboxing sbt +scatterplot +scatterplots Sendmail Sentry serverless Sidekiq +Sisense sharding shfmt Shibboleth @@ -309,13 +408,18 @@ serializing Sitespeed Slack Slony +smartcard +smartcards SMTP Sobelow +Sourcegraph spidering Splunk SpotBugs SSH +Stackdriver storable +storages strace strikethrough strikethroughs @@ -340,7 +444,9 @@ subquerying substring substrings syslog +tcpdump Tiller +timecop todos tokenizer Tokenizers @@ -352,13 +458,15 @@ tooltips Trello triaging TypeScript +Twilio Twitter Ubuntu unarchive unarchived unarchives -Unassign -Unassigns +unarchiving +unassign +unassigns uncheck unchecked unchecking @@ -380,6 +488,7 @@ unmergeable unmerged unmerges unmerging +unmocked unoptimize unoptimized unoptimizes @@ -393,14 +502,20 @@ unpublished unpublishes unpublishing unreferenced +unregister +unregistered +unregisters +unreplicated unresolve unresolved unresolving unschedule +unscoped unstage unstaged unstages unstaging +unstarted unstash unstashed unstashing @@ -418,6 +533,9 @@ upvotes validator validators vendored +versionless +viewport +viewports virtualized virtualizing Vue @@ -425,14 +543,22 @@ Vuex walkthrough walkthroughs WebdriverIO +Webex webpack webserver whitepaper whitepapers +wireframe +wireframes +wireframed +wireframing Wireshark Wordpress +worktree +worktrees Xcode Xeon YouTrack Zeitwerk Zendesk +zsh |