Explain git LFS and use it for the docs #133

fnetX commented 2021年05月29日 14:17:07 +02:00

Git LFS is a nice way to manage large assets that don't need to blow up the Git history size, but can be tracked elsewhere.

We're frequently recommending users with insanely large repos to use Git LFS on Codeberg, but we don't have a section mentioning this. Also, it might be a good idea to introduce it to the docs so that screenshots don't blow up the size.

Basically it works like this: You install the Git LFS plugin (if you don't have it already), you then issue git lfs track "*.filetype" which creates a .gitattributes file to save this information. Each time you add a file of the filetype, the Git history will only store a reference that you added it, the file itself will be stored in Git LFS and can be managed via the repo settings. If you do not need it anymore, you can completely remove it again, the repo size will shrink as it's not stored forever.

More information: https://git-lfs.github.com/

Git LFS is a nice way to manage large assets that don't need to blow up the Git history size, but can be tracked elsewhere. We're frequently recommending users with insanely large repos to use Git LFS on Codeberg, but we don't have a section mentioning this. Also, it might be a good idea to introduce it to the docs so that screenshots don't blow up the size. Basically it works like this: You install the Git LFS plugin (if you don't have it already), you then issue `git lfs track "*.filetype"` which creates a `.gitattributes` file to save this information. Each time you add a file of the filetype, the Git history will only store a reference that you added it, the file itself will be stored in Git LFS and can be managed via the repo settings. If you do not need it anymore, you can completely remove it again, the repo size will shrink as it's not stored forever. More information: https://git-lfs.github.com/