docs icon indicating copy to clipboard operation
docs copied to clipboard

github repository names are, in fact, not case-sensitive

Open jsoref opened this issue 1 year ago • 12 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#check-your-spelling

What part(s) of the article would you like to see updated?

https://github.com/github/docs/blob/03e61d2414c57977d533255060fa59d375ee4421/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md?plain=1#L101

Typos happen, and repository names are case-sensitive. If you try to clone git@{% data variables.command_line.codeblock %}:user/repo.git, but the repository is really named User/Repo you will receive this error.

This is false.

Additional information

% git clone [email protected]:community/community.git --depth 1 --no-tags
Cloning into 'community'...
remote: Enumerating objects: 52, done.
remote: Counting objects: 100% (52/52), done.
remote: Compressing objects: 100% (44/44), done.
remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0
Receiving objects: 100% (52/52), 32.60 KiB | 1.36 MiB/s, done.
Resolving deltas: 100% (20/20), done.
% git clone [email protected]:cOmMuNiTy/CoMmUnItY.git --depth 1 --no-tags
Cloning into 'CoMmUnItY'...
remote: Enumerating objects: 52, done.
remote: Counting objects: 100% (52/52), done.
remote: Compressing objects: 100% (44/44), done.
remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0
Receiving objects: 100% (52/52), 32.61 KiB | 1.42 MiB/s, done.
Resolving deltas: 100% (20/20), done.

jsoref avatar May 07 '24 14:05 jsoref

@jsoref Thank you for opening this issue! I'll get this triaged for review ✨

nguyenalex836 avatar May 07 '24 16:05 nguyenalex836

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors#check-your-spelling

What part(s) of the article would you like to see updated?

https://github.com/github/docs/blob/03e61d2414c57977d533255060fa59d375ee4421/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md?plain=1#L101

Typos happen, and repository names are case-sensitive. If you try to clone git@{% data variables.command_line.codeblock %}:user/repo.git, but the repository is really named User/Repo you will receive this error.

This is false.

Additional information

% git clone [email protected]:community/community.git --depth 1 --no-tags
Cloning into 'community'...
remote: Enumerating objects: 52, done.
remote: Counting objects: 100% (52/52), done.
remote: Compressing objects: 100% (44/44), done.
remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0
Receiving objects: 100% (52/52), 32.60 KiB | 1.36 MiB/s, done.
Resolving deltas: 100% (20/20), done.
% git clone [email protected]:cOmMuNiTy/CoMmUnItY.git --depth 1 --no-tags
Cloning into 'CoMmUnItY'...
remote: Enumerating objects: 52, done.
remote: Counting objects: 100% (52/52), done.
remote: Compressing objects: 100% (44/44), done.
remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0
Receiving objects: 100% (52/52), 32.61 KiB | 1.42 MiB/s, done.
Resolving deltas: 100% (20/20), done.

P3k0pl avatar May 08 '24 03:05 P3k0pl

% git clone [email protected]:community/community.git --depth 1 --no-tags Cloning into 'community'... remote: Enumerating objects: 52, done. remote: Counting objects: 100% (52/52), done. remote: Compressing objects: 100% (44/44), done. remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0 Receiving objects: 100% (52/52), 32.60 KiB | 1.36 MiB/s, done. Resolving deltas: 100% (20/20), done.

P3k0pl avatar May 08 '24 03:05 P3k0pl

% git clone [email protected]:cOmMuNiTy/CoMmUnItY.git --depth 1 --no-tags Cloning into 'CoMmUnItY'... remote: Enumerating objects: 52, done. remote: Counting objects: 100% (52/52), done. remote: Compressing objects: 100% (44/44), done. remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0 Receiving objects: 100% (52/52), 32.61 KiB | 1.42 MiB/s, done. Resolving deltas: 100% (20/20), done.

P3k0pl avatar May 08 '24 03:05 P3k0pl

Ik begrijp het niet ik ken er Nils van ik weet alleen dat mijn gsm heel raar doet bv als ik op trackingsbeveiliging druk doet mijn gsm niets en iemand anders blijft zich inloggen op mijn google account hoe veel ik mijn paswoord ook verander het helpt niet

Tinneke40 avatar May 08 '24 03:05 Tinneke40

Ik begrijp er niets van

Op wo 8 mei 2024 05:55 schreef P3k0pl @.***>:

% git clone @.***:cOmMuNiTy/CoMmUnItY.git --depth 1 --no-tags Cloning into 'CoMmUnItY'... remote: Enumerating objects: 52, done. remote: Counting objects: 100% (52/52), done. remote: Compressing objects: 100% (44/44), done. remote: Total 52 (delta 20), reused 21 (delta 7), pack-reused 0 Receiving objects: 100% (52/52), 32.61 KiB | 1.42 MiB/s, done. Resolving deltas: 100% (20/20), done.

— Reply to this email directly, view it on GitHub https://github.com/github/docs/issues/32838#issuecomment-2099685725, or unsubscribe https://github.com/notifications/unsubscribe-auth/BILAFEJWWLHGVW3T5OS2ECTZBGO2XAVCNFSM6AAAAABHLCWDIKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDAOJZGY4DKNZSGU . You are receiving this because you are subscribed to this thread.Message ID: @.***>

Tinneke40 avatar May 08 '24 03:05 Tinneke40

gh repo clone Shopify/hydrogen

yasser01147310161 avatar May 11 '24 23:05 yasser01147310161

Hey @jsoref, thanks for opening this! ✨ It looks like this was the case at some point many years ago but the docs were never updated when this changed.

I think we can just remove that entire line from the article. You (or anyone else!) is very welcome to open a PR to make this change!

guntrip avatar May 14 '24 09:05 guntrip

I'm inclined to change the example to a homograph (0O/Il1) as the point about copying instead of retyping still stands.

If you have a suggestion for the homograph, we can take it.

jsoref avatar May 14 '24 11:05 jsoref

I think the existing content, once the first line is removed, serves this section well:

To avoid this error, when cloning, always copy and paste the clone URL from the repository's page. For more information, see "Cloning a repository."

To update the remote on an existing repository, see "Managing remote repositories".

A homograph would be two words that sound the same but are spelt differently (close/close). I understand what you mean about characters that can look alike and be confusing (I, l, and 1 as you suggested) but I think the existing suggestion to copy/paste covers this. We're usually wary of adding more content than is necessary. If I've misunderstood, feel free to open your PR with the example and we can review it! ✨

guntrip avatar May 14 '24 13:05 guntrip

Sorry. I meant homoglyph.

jsoref avatar May 14 '24 15:05 jsoref