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

Rewrite clone examples to use HTTPS instead of SSH #1963

Merged
merged 1 commit into from
Oct 30, 2024

Conversation

bgrgicak
Copy link
Collaborator

@bgrgicak bgrgicak commented Oct 30, 2024

Let's use https instead of ssh in our cloning instructions because some people might not have GitHub ssh configured on their machines, while https works for everyone.

A user reported that they have issues with cloning Playground . I'm not sure what the root cause of the issue is, but it prompted me to rewrite the cloning instructions to remove friction from the setup process.

Testing Instructions (or ideally a Blueprint)

  • review readmes
  • try using the cloning command

@bgrgicak bgrgicak requested a review from a team as a code owner October 30, 2024 05:49
@bgrgicak bgrgicak self-assigned this Oct 30, 2024
@bgrgicak bgrgicak added [Type] Documentation Improvements or additions to documentation [Type] Developer Experience [Type] Developer Documentation Documentation for developers labels Oct 30, 2024
@adamziel
Copy link
Collaborator

What are the downsides of defaulting to HTTPS?

@bgrgicak
Copy link
Collaborator Author

What are the downsides of defaulting to HTTPS?

TL;DR; From reading GitHub docs and this article .

  • HTTPS is easier to set up
  • SSH is more secure
  • SSH might be restricted in some firewalls
  • HTTPS is slower

If our goal is to help people get started I would choose HTTPS, because it has less friction.
SSH takes more effort, but long-term is a better approach because of speed and security.

@bgrgicak bgrgicak changed the title Rewrite clone examples to use HTTP instead of SSH Rewrite clone examples to use HTTPS instead of SSH Oct 30, 2024
@adamziel
Copy link
Collaborator

adamziel commented Oct 30, 2024

Sounds good, let's default to HTTP, then.

Performance-wise, they say it might matter with large repos or slow connections – let's stay on the lookout for any unsettling signals from the contributors.

Performance – Generally, there’s not a significant difference in performance between HTTPS and SSH for cloning Git repositories. However, in some cases, SSH might provide faster data transfer rates particularly when working with large repositories or when the internet connection is slow.

@adamziel adamziel merged commit e17cbbd into trunk Oct 30, 2024
9 of 10 checks passed
@adamziel adamziel deleted the update/clone-instructions-with-http branch October 30, 2024 10:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers [Type] Developer Experience [Type] Documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants