Skip to content

Add caps and backtick testing to docs linting

Marcel Amirault requested to merge docs-capitalization-lint-1 into master

What does this MR do?

Expand the linting, as described in the linked issue.

Just to bring some notes over from the issue:

Adds a list of known product names to our linting, to make sure they are properly capitalized. GitLab needs a capital L, jQuery needs a capital Q, NGINX all caps, runit has no caps. If something fails, it's almost always because it needs backticks. Commands, filenames, and similar should all be in backticks, and websites shouldn't be in plain text, they should be in links.

So, for example:

  • Use git log to check your git history. See git-scm.com/docs/git-log. -> FAIL LINT
  • Use git log to check your Git history. See https://git-scm.com/docs/git-log -> PASS LINT

We can collect missed words and make an update to this list in the future.

Related issues

Closes #31185 (closed)

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.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports