kurtosis-tech / kurtosis-testsuite-starter-pack

The Unlicense
1 stars 1 forks source link

Change Quickstart so that it doesn't depend on SSH configuration for git clone #139

Closed galenmarchetti closed 2 years ago

galenmarchetti commented 3 years ago

Right now, quickstart command clones using the git@ prefix which requires SSH verification to be set up on user's github. We've seen a handful of users now get confused when their git clone fails. Right now there's an embedded assumptions that developers will know that SSH verification is required for this style of cloning, but it's been seen to add some level of friction to the onboarding process.

Essence of this is that we're observing there's some significant subset of developers who either always use the HTTPS option to clone github repos, or they just changed their account around and haven't set up the SSH stuff yet. for those developers copy-pasting the quickstart steps don't 'just work', and it's not clear why

mieubrisse commented 3 years ago

We could switch to HTTPS, but Github itself is killing HTTPS (which I agree with): https://www.theregister.com/2021/08/12/git_proxyshell_gigabyte/ This would mean that they'd still get the same failure, but just later when they try to push their repo.

galenmarchetti commented 3 years ago

Ohh nice. Maybe the right thing is to add "SSH auth enabled for github" as a prerequisite in the docs, just to make it clear for users?

mieubrisse commented 2 years ago

Closed in #168