Skip to content

Improve capitalization in geo and HA docs

Marcel Amirault requested to merge docs-capitalization-5-ported into master

What does this MR do?

(Ported from FOSS gitlab-foss!32953 (closed))

Just expanding the list of vocabulary to lint for (someday), and apply it to Geo and HA docs.

markdownlint config entry for capitalization/backticks:

  "proper-names": {
    "names": [
      "Akismet",
      "Alertmanager",
      "API",
      "Auth0",
      "Authentiq",
      "Azure",
      "Bamboo",
      "Bitbucket",
      "Bootstrap",
      "Bugzilla",
      "CAS",
      "CentOS",
      "Consul",
      "Debian",
      "Elasticsearch",
      "Facebook",
      "Git LFS",
      "git-annex",
      "Git",
      "Gitaly",
      "GitHub",
      "GitLab Geo",
      "GitLab Monitor",
      "GitLab Pages",
      "GitLab Rails",
      "GitLab Runner",
      "GitLab Shell",
      "GitLab Workhorse",
      "GitLab",
      "Gmail",
      "Google",
      "Grafana",
      "Helm",
      "HipChat",
      "Ingress",
      "JavaScript",
      "Jaeger",
      "Jenkins",
      "Jira",
      "Jira Cloud",
      "Jira Server",
      "jQuery",
      "JupyterHub",
      "Kerberos",
      "Kubernetes",
      "LDAP",
      "Let's Encrypt",
      "Mattermost",
      "Microsoft",
      "MinIO",
      "NGINX Ingress",
      "NGINX",
      "OAuth",
      "OAuth 2",
      "OmniAuth",
      "Omnibus GitLab",
      "OpenID",
      "OpenShift",
      "PgBouncer",
      "PostgreSQL",
      "Prometheus",
      "Puma",
      "Python",
      "Redis",
      "Redmine",
      "reCAPTCHA",
      "runit",
      "Salesforce",
      "SAML",
      "Sentry",
      "Sidekiq",
      "Shibboleth",
      "Slack",
      "SMTP",
      "SSH",
      "Trello",
      "Trello Power-Ups",
      "Twitter",
      "Ubuntu",
      "Ultra Auth",
      "Unicorn",
      "YouTrack"
    ],
    "code_blocks": false
  }

Related issues

Author's checklist

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports