Skip to content

Add documentation and configuration for using overcommit

Evan Read requested to merge eread/add-overcommit-docs-and-config into master

What does this MR do?

To help with #207921 (closed), this MR adds the documentation and sample configuration required to use the overcommit tool used by some engineers at GitLab already.

This will allow engineers a way of checking their documentation changes without in-editor linting, but also without having to rely on CI/CD pipelines to detect errors. This allows for errors to be detected on git commit before incurring the cost of a pipeline.

CC @gl-docsteam @smcgivern @tkuah just FYI.

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

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

  • 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 Evan Read

Merge request reports