Clean up docs warnings detected by the Vale Substitution Warnings rule
Problem to solve
The vale substitution warnings rule currently gives 220 warnings. It's likely that the vast majority of these can be cleaned up, and moved to the substitution error rule.
Edit: 26 warnings only!
Edit 2: Back up over 1k warnings due to the addition of "need to" -> "must". I think we need to add a new rule for just "need to", and see if we can optimize it with some regex to remove some false positives.
Edit 3: (By Kati) We recently changed our rule for 'administrator', so the affected rows in the table have been updated to reflect the new rule.
Update (Dec 7, 2021): Here are the latest warnings (without "need to" warnings) from this rule that we probably can clean up:
| File | Line:Character | Warning |
|---|---|---|
| administration/gitaly/troubleshooting | 401:95 | If possible, use "repository" instead of "repo". |
| administration/auth/ldap/ldap-troubleshooting | 385:39 | If possible, use "the administrator access level" instead of "Administrator role". |
| administration/instance_limits | 778:64 | If possible, use "filename" instead of "file name". |
| administration/monitoring/performance/performance_bar | 33:7 | If possible, use "configuration" instead of "Config". |
| administration/monitoring/performance/performance_bar | 111:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| administration/monitoring/prometheus/gitlab_metrics | 11:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/project_snippets | 252:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/runners | 89:33 | If possible, use "the administrator access level" instead of "administrator role". |
| api/pages | 15:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/deploy_keys | 12:22 | If possible, use "the administrator access level" instead of "administrator role". |
| api/integrations | 282:106 | If possible, use "information" instead of "info". |
| api/users | 1548:12 | If possible, use "the administrator access level" instead of "administrator permissions". |
| api/users | 1722:12 | If possible, use "the administrator access level" instead of "administrator permissions". |
| api/users | 1767:12 | If possible, use "the administrator access level" instead of "administrator permissions". |
| api/deploy_tokens | 13:88 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/pages_domains | 15:57 | If possible, use "the administrator access level" instead of "administrator role". |
| api/instance_clusters | 20:16 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/plan_limits | 17:5 | If possible, use "the administrator access level" instead of "Administrator role". |
| api/groups | 835:222 | If possible, use "the administrator access level" instead of "administrator role". |
| ci/ci_cd_for_external_repos/bitbucket_integration | 20:16 | If possible, use "repository" instead of "Repo". |
| ci/ci_cd_for_external_repos/index | 12:1 | If possible, use "information" instead of "INFO". |
| ci/ci_cd_for_external_repos/index | 13:14 | If possible, use "repository" instead of "repo". |
| ci/ci_cd_for_external_repos/index | 35:27 | If possible, use "repository" instead of "Repo". |
| ci/ci_cd_for_external_repos/github_integration | 65:58 | If possible, use "repository" instead of "Repo". |
| ci/test_cases/index | 14:1 | If possible, use "information" instead of "INFO". |
| ci/pipelines/pipelines_for_merged_results | 13:1 | If possible, use "information" instead of "INFO". |
| ci/pipelines/merge_trains | 14:1 | If possible, use "information" instead of "INFO". |
| ci/variables/index | 236:52 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/rails_update | 91:51 | If possible, use "filename" instead of "file name". |
| development/scalability | 48:16 | If possible, use "the administrator access level" instead of "administrator role". |
| development/documentation/testing | 311:15 | If possible, use "configuration" instead of "Config". |
| development/documentation/styleguide/index | 1482:5 | If possible, use "information" instead of "Info". |
| development/documentation/styleguide/index | 1517:1 | If possible, use "information" instead of "INFO". |
| development/pipelines | 71:15 | If possible, use "configuration" instead of "config". |
| development/pipelines | 86:15 | If possible, use "configuration" instead of "config". |
| development/pipelines | 200:15 | If possible, use "configuration" instead of "config". |
| development/service_ping/index | 87:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/service_ping/index | 99:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/service_ping/index | 121:1 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/testing_guide/end_to_end/best_practices | 366:31 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/testing_guide/end_to_end/best_practices | 368:37 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/testing_guide/end_to_end/best_practices | 370:43 | If possible, use "the administrator access level" instead of "Administrator role". |
| development/testing_guide/review_apps | 15:30 | If possible, use "configuration" instead of "config". |
| gitlab-basics/start-using-git | 54:17 | If possible, use "repository" instead of "repo". |
| integration/datadog | 29:45 | If possible, use "the administrator access level" instead of "Administrator role". |
| integration/jenkins | 68:4 | If possible, use "the administrator access level" instead of "Administrator role". |
| integration/jira/connect-app | 14:26 | If possible, use "the administrator access level" instead of "administrator role". |
| integration/jira/connect-app | 94:52 | If possible, use "the administrator access level" instead of "Administrator role". |
| integration/saml | 302:36 | If possible, use "the administrator access level" instead of "administrator role". |
| integration/saml | 439:19 | If possible, use "the administrator access level" instead of "administrator role". |
| operations/metrics/dashboards/settings | 26:23 | If possible, use "time zone" instead of "timezone". |
| operations/metrics/dashboards/settings | 26:67 | If possible, use "time zone" instead of "timezone". |
| operations/metrics/dashboards/settings | 29:16 | If possible, use "time zone" instead of "timezone". |
| operations/metrics/alerts | 93:7 | If possible, use "information" instead of "Info". |
| push_rules/push_rules | 17:1 | If possible, use "information" instead of "INFO". |
| raketasks/list_repos | 27:42 | If possible, use "time zone" instead of "TimeZone". |
| raketasks/backup_restore | 438:178 | If possible, use "configuration" instead of "config". |
| subscriptions/index | 10:1 | If possible, use "information" instead of "INFO". |
| user/admin_area/settings/deprecated_api_rate_limits | 33:21 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/sign_in_restrictions | 39:56 | If possible, use "the administrator access level" instead of "administrator role". |
| user/admin_area/settings/files_api_rate_limits | 34:21 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 10:32 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 15:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 32:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 58:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 74:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 87:48 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 89:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 140:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 155:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 169:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 186:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 200:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 212:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/settings/visibility_and_access_controls | 228:38 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/admin_area/index | 384:14 | If possible, use "information" instead of "Info". |
| user/admin_area/index | 393:69 | If possible, use "information" instead of "Info". |
| user/group/epics/epic_boards | 12:1 | If possible, use "information" instead of "INFO". |
| user/group/epics/index | 13:1 | If possible, use "information" instead of "INFO". |
| user/clusters/agent/ci_cd_tunnel | 24:43 | If possible, use "configuration" instead of "config". |
| user/clusters/agent/index | 20:1 | If possible, use "information" instead of "INFO". |
| user/group/saml_sso/index | 17:1 | If possible, use "information" instead of "INFO". |
| user/application_security/coverage_fuzzing/index | 274:84 | If possible, use "information" instead of "Info". |
| user/application_security/security_dashboard/index | 10:1 | If possible, use "information" instead of "INFO". |
| user/application_security/dast/checks/index | 17:74 | If possible, use "information" instead of "Info". |
| user/application_security/dast/checks/16.4 | 24:32 | If possible, use "information" instead of "Info". |
| user/application_security/index | 19:1 | If possible, use "information" instead of "INFO". |
| user/application_security/dependency_scanning/index | 10:1 | If possible, use "information" instead of "INFO". |
| user/application_security/api_fuzzing/index | 15:1 | If possible, use "information" instead of "INFO". |
| user/search/advanced_search | 17:1 | If possible, use "information" instead of "INFO". |
| user/application_security/container_scanning/index | 12:1 | If possible, use "information" instead of "INFO". |
| user/compliance/license_compliance/index | 17:1 | If possible, use "information" instead of "INFO". |
| user/application_security/dast/index | 19:1 | If possible, use "information" instead of "INFO". |
| user/project/settings/import_export | 44:19 | If possible, use "the administrator access level" instead of "administrator role". |
| user/project/settings/index | 360:62 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/project/description_templates | 57:41 | If possible, use "filename" instead of "File name". |
| user/project/requirements/index | 20:1 | If possible, use "information" instead of "INFO". |
| user/project/integrations/mattermost_slash_commands | 70:27 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/project/code_owners | 14:1 | If possible, use "information" instead of "INFO". |
| user/project/import/index | 50:5 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/project/import/github | 184:4 | If possible, use "the administrator access level" instead of "administrator role". |
| user/project/pages/index | 84:15 | If possible, use "the administrator access level" instead of "Administrator role". |
| user/packages/container_registry/index | 912:41 | If possible, use "the administrator access level" instead of "Administrator role". |
Rule: https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/SubstitutionWarning.yml
Edited by Marcel Amirault