Skip to content

Reduce repo size docs - part 2

James Ramsay (ex-GitLab) requested to merge reduce-repo-size-docs-part-2 into master

What does this MR do?

The original documentation provided two workflows, the first of which was simple but minimally effective, while the second was much more complex.

The revisions in this MR:

  • improves the effectiveness of the first method by using the --mirror option
  • removes an unnecessary step
  • documents how to use refs/replace to reduce dead links
  • documents how to split your commit-map if it is too large

Related issues

Closes #229072 (closed)

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 James Ramsay (ex-GitLab)

Merge request reports