Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify Git LFS installation and verification steps #34314

Merged

Conversation

kdotmanoj
Copy link
Contributor

@kdotmanoj kdotmanoj commented Aug 15, 2024

Why:

Closes: #34292

What's being changed (if available, include any code snippets, screenshots, or gifs):

  • Clarified instructions: Updated the documentation to clearly separate the steps for updating the global Git configuration and verifying the installation.
  • Improved verification: Added precise instructions for checking the Git LFS version with git lfs version.
  • Enhanced clarity: Ensured that the necessary steps for proper Git LFS setup are easily understood.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Aug 15, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Aug 15, 2024
Copy link
Contributor

github-actions bot commented Aug 15, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836
Copy link
Contributor

@kdotmanoj Thank you for opening a PR ✨

@aledefault Given our conversation in the linked issue, we wanted to give you chance to review this PR 💛 please feel free to ping here once you are finished reviewing!

CC @subatoi

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team enterprise Content relating to GitHub Enterprise and removed triage Do not begin working on this issue until triaged by the team labels Aug 15, 2024
@aledefault
Copy link

@kdotmanoj Thank you for opening a PR ✨

@aledefault Given our conversation in the linked issue, we wanted to give you chance to review this PR 💛 please feel free to ping here once you are finished reviewing!

CC @subatoi

In my opinion, I'll keep it as close, if not literal to this @subatoi comment.

In addition to that, not only the Linux version should be updated, also Mac (there are more than one installation method) and Windows (if needed) as well.

By the way, there is already a .md talking about "lfs installation verification". It could be interesting to keep the verification quite similar to that.

Sorry I can't be more helpful. I'm on my smartphone with no access to a laptop.

@subatoi
Copy link
Contributor

subatoi commented Aug 15, 2024

I agree with @aledefault — I misspoke slightly when I singled out line 116. Whilst line 116 does need to change, we also need to change line 48 for macOS.

In both these cases I'd keep it to the one-line change:

Next, make required changes to your global Git config:

In the case of Windows, I think we should leave it as it is, as it's technically correct and users are likely to have a range of different configurations—but I'm very open to discussing that.

We could certainly add a reference to the reusable @aledefault mentioned after this new change, so that could go in this PR or a separate one.

@kdotmanoj
Copy link
Contributor Author

Thanks @aledefault & @subatoi for your input!
I'll make single line changes on both lines 48 and 116 and raise PR for now.

@nguyenalex836
Copy link
Contributor

@kdotmanoj Thank you for making that update to your PR! ✨ I'll update the branch and get this merged once tests are passing 🍏

@nguyenalex836 nguyenalex836 added this pull request to the merge queue Aug 15, 2024
Merged via the queue into github:main with commit ef31482 Aug 15, 2024
44 checks passed
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team enterprise Content relating to GitHub Enterprise
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusing verification step in "Installing Git Large File Storage"
4 participants