Document removal of LFS objects from repo to reduce size
What does this MR do?
Based on a customer report (internal), I've been testing our guide with respect to LFS files a bit. I'm not quite certain yet, whether a step is definitely missing, or if this addition is the answer.
In any case, it seems like some step to specifically make LFS items "unused" is missing, so that the final cleanup can actually "unlink" them.
@eread: In my initial tests, the commits that reference an LFS object needed to be removed/pruned from the history. git filter-repo
does not do this, does it? I'm looking at newren/git-filter-repo#257 & newren/git-filter-repo#355 and think not, because the small pointer files will almost never be highlighted as items to be removed, when users follow the gist examples in our guide. Thus, I'm thinking that we should add 1 or 2 sentences about how to approach removing LFS objects also from the server specifically. The prune
part of this MR is only for local LFS objects.
Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: - [-] If you're adding or changing the main heading of the page (H1), ensure that the product tier badge is added.
-
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
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 likeDefault behavior when you close an issue
. -
The headings (other than the page title) should be active. Instead of Configuring GDK
, say something likeConfigure 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.