Confusing verification step in "Installing Git Large File Storage" about docs

[nguyenalex836]

@aledefault Thanks so much for opening an issue! I'll get this triaged for review ✨

[nguyenalex836]

@aledefault @nguyenalex836 if this issue gets triaged, could you please assign it to me? Thanks!

Hello @kdotmanoj!👋 We don't generally assign issues to contributors. However, once this issue has been reviewed, you are welcome to submit a PR ✨

[aledefault]

Hi @subatoi, you're welcome.

Quoting the official site:
Download and install the Git command line extension. Once downloaded and installed, set up Git LFS for your user account by running...

In their GitHub they used:

Git LFS requires global configuration changes once per-machine. This can be done by running: git lfs install
...
Run git lfs install to perform required global configuration changes.

I think your proposition is good. And maybe not "a must" but add something like "required global Git config". It implies that the config it's actually required for it to work, but you could add it manually (rare case I suppose).

[subatoi]

That sounds good to me—let's change line 116 to something like:

Next, make required changes to your global Git config:

I've opened that up to contributors with the help wanted label so it's ready for a PR.

Thank you again!

[kdotmanoj]

Hi @subatoi, @nguyenalex836, and @aledefault,

I have raised a PR #34314 addressing the discussion points related to this issue. Please review the changes and let me know if you have any further suggestions or comments.

Thank you!

[welcome]

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

[kdotmanoj]

@aledefault @nguyenalex836 if this issue gets triaged, could you please assign it to me? Thanks!

[subatoi]

Hi @aledefault, thanks for raising an issue before going ahead and raising a PR. We really appreciate it.

I agree this is misleading—

I'd suggest we change line 116 to say something like "Next, update your global Git config:"

I think we can safely assume advanced users who may not want to run that step will be able to make that judgement independently (hence my suggestion to not use absolute language like "you must")

Once we're agreed, I'm happy to add a help wanted label to this PR.

[kdotmanoj]

@aledefault @nguyenalex836 if this issue gets triaged, could you please assign it to me? Thanks!

Hello @kdotmanoj!👋 We don't generally assign issues to contributors. However, once this issue has been reviewed, you are welcome to submit a PR ✨

As this issue is now open for contributions I'll be working on it!