Codeberg/Documentation
42
199
Fork
You've already forked Documentation
161

LFS-documentation #231

Merged
Ghost merged 4 commits from :describe-use-of-lfs-#133 into main 2022年06月16日 21:20:38 +02:00
Contributor
Copy link

Initial version of an article on LFS

Fixes: #133

Initial version of an article on LFS Fixes: #133
@ -0,0 +6,4 @@
order: 70
---
Tracking huge files (files bigger than a few megabyte) with git can (over time) lead to a big repository size.

I'd prefer this to be a more clear, something like:

To track large ( a few megabytes) binary files with Git, you need to use git-lfs.

I'd prefer this to be a more clear, something like: > To track large ( a few megabytes) binary files with Git, you need to use `git-lfs`.
Owner
Copy link

Or something like

Storing large (a few megabytes) binary files in Git is usually a bad idea. They are contained in the history forever, and thus blow up your repository size, annoys your contributors, costs us more storage.
But there is a good solution:
Using Git LFS (Large File Storage), you can easily manage binary files, and remove them permanently when they are no longer necessary.

Or something like > Storing large (a few megabytes) binary files in Git is usually a bad idea. They are contained in the history forever, and thus blow up your repository size, annoys your contributors, costs us more storage. > But there is a good solution: > Using Git LFS (Large File Storage), you can easily manage binary files, and remove them permanently when they are no longer necessary.
@ -0,0 +18,4 @@
You can install it from the [git-lfs-Website][git-lfs] or via the package manager of your distribution.
A more detailed installation description can be found at the [Installation article](https://github.com/git-lfs/git-lfs/wiki/Installation) of the git-lfs wiki.
After installation of the git-lfs plugin, it must be installed into your git configuration (the git config OS-user you want to use git-lfs with).

Can you rephrase the config part?

"git config OS-user" seems overly complicated.

proposal:

After the installation of the git-lfs plugin, it needs to be enabled in your Git configuration.

Can you rephrase the config part? "git config OS-user" seems overly complicated. proposal: > After the installation of the git-lfs plugin, it needs to be enabled in your Git configuration.
Ghost marked this conversation as resolved
@ -0,0 +73,4 @@
Locking ensures that the files you are trying to push not modified at the same time.
It also ensures that other users cannot modify the file at the same time.

The sentences in 74 and 76 are somewhat duplicate.

The sentences in 74 and 76 are somewhat duplicate.
Ghost marked this conversation as resolved
@ -0,0 +104,4 @@
### Enabling LFS in an existing repository
If you already have a file with a big file size in your repository, it will not automatically be moved to lfs by just enabling the tracking.

proposal:

If you already have **a big file ** in your repository

proposal: > If you already have **a big file ** in your repository
Ghost marked this conversation as resolved

Hi @jklippel , thanks for the PR.

I've left some comments.

Hi @jklippel , thanks for the PR. I've left some comments.
Owner
Copy link

Not sure if this is in the style guide, but we should write "Git" with a capital letter at the beginning.

Not sure if this is in the style guide, but we should write "Git" with a capital letter at the beginning.
Author
Contributor
Copy link

Not sure if this is in the style guide, but we should write "Git" with a capital letter at the beginning.

No it is actually not. I created a reminder issue #232.

> Not sure if this is in the style guide, but we should write "Git" with a capital letter at the beginning. No it is actually not. I created a reminder issue #232.
@ -0,0 +7,4 @@
---
Storing large (a few megabytes) binary files in Git is usually a bad idea.
They are contained in the history forever, and thus blow up your repository size, annoys your contributors and costs Codeberg more storage.

Can you rephrase this, something like:

They are contained in the history forever and blow up your repository size, which annoys your contributors and increases storage cost on Codeberg.

Can you rephrase this, something like: > They are contained in the history forever and blow up your repository size, which annoys your contributors and increases storage cost on Codeberg.
@ -0,0 +12,4 @@
But there is a good solution:
Using [Git LFS (Large File Storage)][git-lfs], you can easily manage binary files, and remove them permanently when they are no longer necessary.
The files are still be tracked with Git but the actual content is stored elsewhere on the Codeberg server side.

...still being tracked

...still be**ing** tracked
Author
Contributor
Copy link

Seen it, will update it. Unfortunately do not expect updates before 12.06.

Seen it, will update it. Unfortunately do not expect updates before 12.06.
Author
Contributor
Copy link

Finally found the time to do the changes. Can you please take another look?

Finally found the time to do the changes. Can you please take another look?
jklippel force-pushed describe-use-of-lfs-#133 from a1f1eccb0e to af1b7eba18 2022年06月16日 10:40:14 +02:00 Compare
jklippel deleted branch describe-use-of-lfs-#133 2022年06月19日 11:33:26 +02:00
Sign in to join this conversation.
No reviewers
Labels
Clear labels
Codeberg Pages
Issues affecting Codeberg Pages
Documentation Usability
Issues related to using and reading docs.codeberg.org
Forgejo
Good First Issue! 👋
Kind: Bug
Kind: Documentation
Kind: Enhancement
Kind: Feature
Kind: Question
Kind: Security
Licensing
Part: Generator
This is related to the generation of the documentation, not to the content itself
Priority: High
The priority is high
Priority: Low
The priority is low
Priority: Medium
The priority is medium
Reviewed: Confirmed
Something has been confirmed
Reviewed: Duplicate
Something exists already
Reviewed: Invalid
Something was marked as invalid
Reviewed: Wontfix
Something won't be fixed
Status: Blocked
Status: Help wanted
Contributions are welcome!
Status: In progress
Work is in progress
Status: Needs feedback
Feedback is needed
Status: Ready for Review
Work is completed
Status: Review
Review is in progress / Reviewers wanted
Status: Stale
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Codeberg/Documentation!231
Reference in a new issue
Codeberg/Documentation
No description provided.
Delete branch ":describe-use-of-lfs-#133"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?