Skip to content

Explain reference processing in commits

Amy Qualls requested to merge 31066-aqualls-instance-limits into master

What does this MR do?

Addresses Igor's request from ages ago in https://gitlab.com/gitlab-org/gitlab/-/issues/31066#note_1019210477 to add information to https://docs.gitlab.com/ee/administration/instance_limits.html#size-of-commit-titles-and-descriptions. Something like this:

When a commit is pushed, GitLab processes its title and description to enrich the content. For example, !123 and #124 references are replaced with actual links to the issues and merge requests. When a branch with a large number of commits is pushed, only the latest 100 commits are processed.

While here, I fixed a couple of punctuation and spacing issues in the subheading.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports

Loading