diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-12-20 14:22:11 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-12-20 14:22:11 +0000 |
commit | 0c872e02b2c822e3397515ec324051ff540f0cd5 (patch) | |
tree | ce2fb6ce7030e4dad0f4118d21ab6453e5938cdd /doc/.vale | |
parent | f7e05a6853b12f02911494c4b3fe53d9540d74fc (diff) | |
download | gitlab-ce-0c872e02b2c822e3397515ec324051ff540f0cd5.tar.gz |
Add latest changes from gitlab-org/gitlab@15-7-stable-eev15.7.0-rc42
Diffstat (limited to 'doc/.vale')
-rw-r--r-- | doc/.vale/gitlab/CurrentStatus.yml | 5 | ||||
-rw-r--r-- | doc/.vale/gitlab/ElementDescriptors.yml | 17 | ||||
-rw-r--r-- | doc/.vale/gitlab/InclusionAbleism.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/InclusionGender.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Normal.yml | 14 | ||||
-rw-r--r-- | doc/.vale/gitlab/Simplicity.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/SubstitutionSuggestions.yml | 29 | ||||
-rw-r--r-- | doc/.vale/gitlab/SubstitutionWarning.yml | 27 | ||||
-rw-r--r-- | doc/.vale/gitlab/Substitutions.yml | 3 | ||||
-rw-r--r-- | doc/.vale/gitlab/Units.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Uppercase.yml | 2 | ||||
-rw-r--r-- | doc/.vale/gitlab/spelling-exceptions.txt | 309 |
12 files changed, 363 insertions, 59 deletions
diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 57b95dcf4ac..9972573b406 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -1,14 +1,13 @@ --- -# Suggestion: gitlab.CurrentStatus +# Warning: gitlab.CurrentStatus # # Checks for words that indicate a product or feature may change in the future. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Remove '%s'. The documentation reflects the current state of the product." -level: suggestion +level: warning ignorecase: true link: https://docs.gitlab.com/ee/development/documentation/versions.html#promising-features-in-future-versions tokens: - currently - - yet diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index f3573f5ce65..f806f5878e1 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -1,13 +1,14 @@ --- -# Suggestion: gitlab.ElementDescriptors +# Warning: gitlab.ElementDescriptors # -# Suggests the correct way to describe elements in a form. +# Suggests the correct way to describe a button. # # 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 -level: suggestion +extends: existence +message: "If possible, rewrite to remove 'button'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#button +level: warning ignorecase: true -swap: - button: 'if possible, rewrite to remove' +scope: raw +raw: + - \*\*.+?\*\* button diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 7419430c8a2..3ee356155cd 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.InclusionAbleism +# Warning: gitlab.InclusionAbleism # # Suggests alternatives for words that foster ableism. # @@ -7,7 +7,7 @@ extends: substitution message: "Use inclusive language. Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html -level: suggestion +level: warning ignorecase: true swap: sanity (?:check|test): check for completeness diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index ce8861b6a09..dcf8c1930ec 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.InclusionGender +# Warning: gitlab.InclusionGender # # Suggests alternatives for words that are gender-specific. # @@ -7,7 +7,7 @@ extends: substitution message: "Use inclusive language. Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html -level: suggestion +level: warning ignorecase: true swap: mankind: humanity, people diff --git a/doc/.vale/gitlab/Normal.yml b/doc/.vale/gitlab/Normal.yml new file mode 100644 index 00000000000..0ced9f3318e --- /dev/null +++ b/doc/.vale/gitlab/Normal.yml @@ -0,0 +1,14 @@ +--- +# Warning: gitlab.Normal +# +# Suggests alternatives for 'normal'. +# +# For a list of all options, see https://vale.sh/docs/topics/styles/ +extends: substitution +message: "Use '%s' instead of '%s'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html +level: warning +ignorecase: true +swap: + normally: "usually' or 'typically" + normal: "typical' or 'standard" diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index 89169c1aa46..fd9b1c5e5a6 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -1,12 +1,12 @@ --- -# Suggestion: gitlab.Simplicity +# Warning: gitlab.Simplicity # # Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Remove '%s'. Be precise instead of subjective." -level: suggestion +level: warning ignorecase: true link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html tokens: diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml deleted file mode 100644 index 21cabf1e0a7..00000000000 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ /dev/null @@ -1,29 +0,0 @@ ---- -# Suggestion: gitlab.SubstitutionSuggestions -# -# 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://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 -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" - 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" diff --git a/doc/.vale/gitlab/SubstitutionWarning.yml b/doc/.vale/gitlab/SubstitutionWarning.yml index 8d6c18c1520..383ae38da16 100644 --- a/doc/.vale/gitlab/SubstitutionWarning.yml +++ b/doc/.vale/gitlab/SubstitutionWarning.yml @@ -1,16 +1,18 @@ --- # Warning: gitlab.SubstitutionWarning # -# 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. +# Checks for misused terms or common shorthand that should not be used at GitLab, but can't be flagged as errors. +# Substitutions.yml also exists. # # 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 +message: "Use '%s' instead of '%s' when possible." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html level: warning ignorecase: true swap: + active user: "billable user" + active users: "billable users" air(?:-| )?gapped: "offline environment" bullet: "list item" click: "select" @@ -19,11 +21,26 @@ swap: deselect: "clear" deselected: "cleared" distro: "distribution" + docs: "documentation" + e-mail: "email" + ex: "for example" file name: "filename" filesystem: "file system" - GFM: "'GitLab Flavored Markdown' or 'GitHub Flavored Markdown'" + GLFM: "GitLab Flavored Markdown" + GFM: "GitLab Flavored Markdown' or 'GitHub Flavored Markdown" info: "information" + it is recommended: "you should" n/a: "not applicable" + navigate to: "go to" + OAuth2: "OAuth 2.0" + once that: "after that" + once the: "after the" + once you: "after you" repo: "repository" + since: "because' or 'after" + sub-group: "subgroup" + sub-groups: "subgroups" timezone: "time zone" utilize: "use" + we recommend: "you should" + within: "in" diff --git a/doc/.vale/gitlab/Substitutions.yml b/doc/.vale/gitlab/Substitutions.yml index 92791486491..675abc6ef6d 100644 --- a/doc/.vale/gitlab/Substitutions.yml +++ b/doc/.vale/gitlab/Substitutions.yml @@ -2,7 +2,7 @@ # Error: gitlab.Substitutions # # Checks for misused terms that should never be used at GitLab. -# SubstitutionWarning.yml and SubstitionSuggestions.yml also exist. +# SubstitutionWarning.yml also exists. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: substitution @@ -60,3 +60,4 @@ swap: reporter access: the Reporter role reporter permission: the Reporter role reporter permissions: the Reporter role + at least the Owner role: the Owner role diff --git a/doc/.vale/gitlab/Units.yml b/doc/.vale/gitlab/Units.yml index 4211fdee38b..e6263ad66b4 100644 --- a/doc/.vale/gitlab/Units.yml +++ b/doc/.vale/gitlab/Units.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.Units +# Warning: gitlab.Units # # Recommends a space between a number and a unit of measure. # @@ -8,7 +8,7 @@ extends: existence message: "Add a space between the number and the unit in '%s'." link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/' nonword: true -level: suggestion +level: warning ignorecase: true tokens: - \d+(?:B|kB|KiB|MB|MiB|GB|GiB|TB|TiB) diff --git a/doc/.vale/gitlab/Uppercase.yml b/doc/.vale/gitlab/Uppercase.yml index f53e1c72dcb..039ad7c5f03 100644 --- a/doc/.vale/gitlab/Uppercase.yml +++ b/doc/.vale/gitlab/Uppercase.yml @@ -39,6 +39,7 @@ exceptions: - CORE - CORS - CPU + - CRAN - CRIME - CRM - CRUD @@ -188,6 +189,7 @@ exceptions: - SAST - SATA - SBOM + - SBT - SCIM - SCM - SCP diff --git a/doc/.vale/gitlab/spelling-exceptions.txt b/doc/.vale/gitlab/spelling-exceptions.txt index 0fc7c9703ac..81b21f026f4 100644 --- a/doc/.vale/gitlab/spelling-exceptions.txt +++ b/doc/.vale/gitlab/spelling-exceptions.txt @@ -1,35 +1,53 @@ accessor accessors +ACLs +Adafruit +Airbnb +Airtable Akismet Alertmanager Algolia Alibaba +aliuid Aliyun allowlist allowlisted allowlisting allowlists AlmaLinux +AMIs anonymization anonymized Ansible Anthos -Apdex +Anycast +apdex +API +APIs Apparmor +Appetize approvers +Appsec architected architecting archiver Arel arity +Arkose +armhf +ARNs Artifactory Asana Asciidoctor asdf Assembla +Astro +async Atlassian auditability +auditable Auth0 +authenticator Authentiq Authy autocomplete @@ -40,18 +58,22 @@ autogenerated autoloaded autoloader autoloading +automatable autoscale autoscaled autoscaler +autoscalers autoscales autoscaling awardable awardables Axios Ayoa +AZs Azure B-tree backfilling +backfills backport backported backporting @@ -61,11 +83,16 @@ backtraced backtraces backtracing badging +balancer +balancer's Bamboo Bazel +bcrypt +Beamer Bhyve Bitbucket Bitnami +Bittrex blockquote blockquoted blockquotes @@ -73,6 +100,8 @@ blockquoting boolean booleans Bootsnap +bot +bot's Bottlerocket browsable bugfix @@ -88,15 +117,24 @@ bundlers burndown burnup burstable +CA cacheable Caddy +callout +callouts callstack callstacks +camelCase +camelCased Camo canonicalization canonicalized captcha +CAPTCHAs +Capybara Casdoor +CDNs +CE CentOS Ceph Certbot @@ -110,28 +148,57 @@ ChaosKube chatbot chatbots ChatOps +checksummable checksummed checksumming Chemlab +chipset +chipsets +CIDRs Citrix Citus +Civo +Cleartext +Clickhouse +CLIs +Clojars clonable Cloudwatch +clusterized +CMake +CMK +CMKs +CNAs +CNs Cobertura Codeception +Codecov +codenames Codepen +CodeSandbox Cognito +Coinbase +colocate colocated colocating +commit's +CommonMark compilable composable composables Conda +config +Configs Consul Contentful Corosync +corpuses Coursier +CPU +CPUs +CRAN cron +crond cronjob cronjobs crons @@ -142,31 +209,53 @@ crosslinking crosslinks Crossplane Crowdin +crypto +CSSComb CSV +CSVs +CTAs +CTEs +CUnit customappsso +CVEs +CWEs cybersecurity +CycloneDX Dangerfile +DAST +Databricks Datadog datasource datasources +datastore +datastores +datestamp datetime +DBeaver Debian +debloating +decodable Decompressor decryptable +dedupe deduplicate deduplicated deduplicates deduplicating deduplication +delegators deliverables +denormalization denormalize denormalized denormalizes denormalizing +dentry denylist denylisted denylisting denylists +Depesz deployer deployers deprovision @@ -180,14 +269,22 @@ deserialization deserialize deserializers deserializes +desugar +desugars +desynchronized +Dev DevOps Dhall +dialogs disambiguates discoverability dismissable Disqus Distroless Divio +DLE +DNs +Docker Dockerfile Dockerfiles Dockerize @@ -196,20 +293,37 @@ Dockerizing dogfood dogfooding dogfoods +DOMPurify dotenv +doublestar downvoted downvotes Dpl +dput Dreamweaver +DRIs +DSLs +Dynatrace Ecto +eden +EGit ElastiCache Elasticsearch +Eleventy enablement +Encrypt enqueued enqueues +enricher +enrichers enum enums +Enviroments +ESLint +ESXi ETag +ETags +Etsy Excon exfiltration ExifTool @@ -220,35 +334,49 @@ failovers failsafe Falco falsy +Fanout Fargate fastlane +Fastly Fastzip favicon favorited +ffaker Figma Filebeat +Filestore +Finicity +Finnhub Fio firewalled firewalling fixup +flamegraph +flamegraphs Flawfinder -Flowdock +Flickr Fluentd +Flutterwave Flycheck +focusable Forgerock formatters Fortinet +FQDNs +FreshBooks +frontend Fugit fuzzer +fuzzing Gantt Gbps Gemfile Gemnasium Gemojione Getter -getters Getters gettext +GIDs Git Gitaly Gitea @@ -258,25 +386,32 @@ gitlabsos Gitleaks Gitpod Gitter +GLab globals +globbing Gmail Godep +Golang Gollum Google goroutine goroutines Gosec +GPUs Gradle Grafana Grafonnet gravatar Grype +GUIs Gzip Hackathon Haml +HAProxy hardcode hardcoded hardcodes +HashiCorp Haswell heatmap heatmaps @@ -284,6 +419,8 @@ Helm Helmfile Heroku Herokuish +heuristical +hexdigest Hexo HipChat hostname @@ -292,21 +429,34 @@ hotfix hotfixed hotfixes hotfixing +hotspots http https +hyperparameter +hyperparameters +iCalendar +iCloud idempotence idmapper Iglu +IIFEs Immer inclusivity +inflector +inflectors Ingress initializer initializers +injective innersource innersourcing +inodes interdependencies interdependency interruptible +inviter +IPs +IPython irker issuables Istio @@ -317,16 +467,23 @@ JavaScript Jenkins Jenkinsfile Jira +Jitsu jq jQuery +JRuby +JSDoc jsdom Jsonnet +JUnit JupyterHub +JWT +JWTs Kaminari kanban kanbans kaniko Karma +KCachegrind Kerberos Keycloak keyset @@ -339,18 +496,24 @@ Klar Knative Kramdown Kroki +kubeconfig Kubecost kubectl Kubernetes Kubesec +Kucoin Kustomize +kwargs Laravel +LaunchDarkly ldapsearch Lefthook Leiningen libFuzzer +Libgcrypt Libravatar liveness +lockfile lockfiles Lodash Lograge @@ -361,14 +524,19 @@ lookahead lookaheads lookbehind lookbehinds +Lookbook lookups loopback +Lua Lucene +macOS +Mailchimp Maildir Mailgun Mailroom Makefile Makefiles +malloc Markdown markdownlint Marketo @@ -379,15 +547,19 @@ Mattermost mbox memoization memoize +memoizes memoized memoizing Memorystore mergeability mergeable metaprogramming +metric's +microformat Microsoft middleware middlewares +migratable migratus minikube MinIO @@ -401,6 +573,8 @@ mitigations mitmproxy mixin mixins +MLFlow +Mmap mockup mockups ModSecurity @@ -408,52 +582,82 @@ Monokai monorepo monorepos monospace +MRs +MSBuild multiline mutex nameserver nameservers namespace namespaced +namespace's namespaces namespacing namespacings Nanoc +NAT +navigations negatable Netlify +NGINX +ngrok +njsscan Nokogiri nosniff noteable noteables npm +NuGet nullability nullable Nurtch +NVMe nyc OAuth Octokit offboarded offboarding offboards +OIDs +OKRs Okta OmniAuth onboarding OpenID OpenShift Opsgenie +Opstrace +ORMs +OS +OSs outdent Overcommit Packagist +packfile +packfiles +Packwerk +paginator parallelization parallelizations +PascalCase +PascalCased +passthrough +passthroughs passwordless +parsable Patroni +PDFs performant PgBouncer +pgFormatter pgLoader +pgMustard Phabricator phaser phasers phpenv +PHPUnit +PIDs pipenv Pipfile Pipfiles @@ -464,25 +668,34 @@ polyfill polyfills pooler postfixed +Postgres postgres.ai PostgreSQL +Praefect's +prebuild +prebuilds precompile precompiled preconfigure preconfigured preconfigures +prefetch +prefetching prefill prefilled prefilling prefills preload +preloaded preloading preloads prepend prepended prepending prepends +prepopulate prepopulated +presentationals Prettifier Pritaly Priyanka @@ -499,15 +712,20 @@ pseudocode pseudonymization pseudonymized pseudonymizer +Pulumi Puma +Pumble +PyPI pytest Python Qualys queryable Quicktime Rackspace +railties Raspbian rbenv +rbspy rbtrace Rclone Rdoc @@ -523,7 +741,9 @@ rebase rebased rebases rebasing +rebinding reCAPTCHA +recoverability Redcarpet redirection redirections @@ -534,8 +754,13 @@ referer referers reflog reflogs +refname refspec refspecs +regexes +Rego +reimplementation +reimplemented reindex reindexed reindexes @@ -545,15 +770,19 @@ reinitializing relicensing remediations renderers +renderless replicables -rpcs repmgr repmgrd +reposts repurposing +requestee +requesters requeue requeued requeues requeuing +resolver Restlet resync resynced @@ -567,10 +796,15 @@ reusability reverified reverifies reverify +reviewee +RIs roadmap roadmaps +rock rollout rollouts +routable +RPCs RSpec rsync rsynced @@ -580,6 +814,8 @@ Rubinius Rubix RuboCop Rubular +RubyGems +Rugged ruleset rulesets runbook @@ -590,13 +826,22 @@ runtimes Salesforce sandboxing sanitization +SBOMs +SBT sbt scalers scatterplot scatterplots +schedulable Schemastore +scriptable scrollable +SDKs +segmentations +SELinux Semgrep +Sendbird +Sendinblue Sendmail Sentry serializer @@ -605,10 +850,13 @@ serializing serverless setuptools severities +SFCs sharded sharding +SHAs shfmt Shimo +Shippo Shopify Sidekiq Silverlight @@ -618,10 +866,16 @@ skippable skopeo Slack Slackbot +SLAs +SLIs Slony +SLOs smartcard smartcards +snake_case +snake_cased snapshotting +Snowplow Snyk Sobelow Solargraph @@ -631,9 +885,14 @@ Spamcheck spammable sparkline sparklines +Speedscope spidering Splunk SpotBugs +Squarespace +SREs +SSDs +SSGs Stackdriver Stackprof starrer @@ -649,6 +908,7 @@ subchart subcharts subcommand subcommands +subcomponent subfolder subfolders subgraph @@ -661,6 +921,8 @@ sublicense sublicensed sublicenses sublicensing +submodule +submodule's subnet subnets subnetting @@ -677,15 +939,20 @@ subtask subtasks subtest subtests +subtransaction +subtransactions subtree subtrees sudo +sunsetting supercookie supercookies +supergroup superset supersets supertype supertypes +SVGs swappiness swimlane swimlanes @@ -695,8 +962,12 @@ syscall syscalls syslog systemd +tablespace +tablespaces tanuki +taskscaler tcpdump +teardown templated Thanos Thoughtbot @@ -707,7 +978,9 @@ timeboxed timeboxes timeboxing timecop -tiptap +timelog +timelogs +Tiptap todos tokenizer Tokenizers @@ -717,6 +990,7 @@ toolchain toolchains toolkit toolkits +toolset tooltip tooltips transactionally @@ -725,6 +999,7 @@ transpiled transpiles transpiling Trello +Trendline triaged triages triaging @@ -733,9 +1008,13 @@ Truststore truthy Twilio Twitter +Typeform TypeScript +TZInfo Ubuntu Udemy +UI +UIDs unapplied unapprove unapproved @@ -749,6 +1028,8 @@ unassign unassigning unassigns unban +unbans +uncached uncheck unchecked unchecking @@ -757,6 +1038,7 @@ uncomment uncommented uncommenting uncordon +underperforming unencode unencoded unencoder @@ -782,6 +1064,7 @@ unoptimized unoptimizes unoptimizing unpatched +unpause unprioritized unprotect unprotected @@ -794,6 +1077,7 @@ unpublish unpublished unpublishes unpublishing +unpullable unpushed unreferenced unregister @@ -804,6 +1088,7 @@ unresolve unresolved unresolving unreviewed +unrevoke unsanitized unschedule unscoped @@ -835,10 +1120,14 @@ upstreams upvote upvoted upvotes +urgencies URIs +URL +UUIDs Vagrantfile validator validators +vCPUs vendored vendoring versionless @@ -846,13 +1135,18 @@ viewport viewports virtualized virtualizing +Vite +VMs +VPCs Vue Vuex +waitlist walkthrough walkthroughs WebdriverIO Webex webpack +WEBrick webserver Webservice websocket @@ -866,17 +1160,22 @@ wireframing Wireshark Wordpress Workato +workstream worktree worktrees Worldline Xcode Xeon +XPath +Yandex YouTrack ytt Yubico Zabbix +ZAProxy Zeitwerk Zendesk ZenTao zsh Zstandard +Zuora |