Skip to content

Change wording of commit-map size advisory

Justin Farmiloe requested to merge jfarmiloe-docs-commit-map into master

What does this MR do?

The previous text suggested that the maximum size for a commit-map file should be 3000 lines, otherwise the background cleanup task may fail with timeout errors. This is very dependent on the capacity of the gitlab instance and resulted from a self-managed ticket. However in a recent ticket resizing a very complex repository on gitlab.com a much larger commit-map file was processed in one go without any problems, but only after the customer has spent many hours in an earlier attempt uploading 80+ 3000 line files due to following the documented advice, which may in itself have contributed to the process not working correctly.

So I've changed the wording to be less prescriptive and have increased the example line count to 20000.

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 you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • 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