Skip to content

Commit c711b0a

Browse files
authored
Merge pull request #89 from lewagon/clarify-ssh-email
bump ruby clarify ssh email
2 parents 3e7b657 + 21225cd commit c711b0a

5 files changed

Lines changed: 37 additions & 31 deletions

File tree

.ruby-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.1.2
1+
4.0.5

LINUX.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ We highly recommend installing [Windows Terminal](https://apps.microsoft.com/sto
7676
<summary markdown='span'>Windows</summary>
7777

7878
```bash
79-
# replace "your_email@example.com" with your GCP account email
80-
ssh-keygen.exe -t ed25519 -C "your_email@example.com"
79+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
80+
ssh-keygen.exe -t ed25519 -C your_email@example.com
8181
```
8282
</details>
8383

8484
<details>
8585
<summary markdown='span'>MacOS & Linux</summary>
8686

8787
```bash
88-
# replace "your_email@example.com" with your GCP account email
89-
ssh-keygen -t ed25519 -C "your_email@example.com"
88+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
89+
ssh-keygen -t ed25519 -C your_email@example.com
9090
```
9191
</details>
9292

@@ -108,8 +108,8 @@ If you receive this message, you may already have an SSH Key with the same name
108108
To create a separate SSH key to exclusively use for this bootcamp use the following:
109109

110110
```bash
111-
# replace "your_email@example.com" with your GCP account email
112-
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com"
111+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
112+
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C your_email@example.com
113113
```
114114

115115
Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
@@ -513,7 +513,7 @@ We will use the GitHub CLI (`gh`) to connect to GitHub using *SSH*, a protocol t
513513

514514
First in order to **login**, copy-paste the following command in your terminal:
515515

516-
:warning: **DO NOT edit the `email`**
516+
:warning: **DO NOT edit the `email`** — Even though `user:email` looks like a placeholder for your actual email address, it isn't — do not replace it.
517517

518518
```bash
519519
gh auth login -s 'user:email' -w --git-protocol ssh
@@ -525,7 +525,9 @@ gh auth login -s 'user:email' -w --git-protocol ssh
525525

526526
If you already have SSH keys, you will see instead `Upload your SSH public key to your GitHub account?` With the arrows, select your public key file path and press `Enter`.
527527

528-
- `Enter a passphrase for your new SSH key (Optional)`. Type something you want and that you'll remember. It's a password to protect your private key stored on your hard drive. Then press `Enter`.
528+
- `Enter a passphrase for your new SSH key (Optional)`:
529+
- **FOR MOST PEOPLE:** Just press `Enter` to skip. You don't need a passphrase for the bootcamp and it would prompt you every time you use the key. There is a risk, however, that if someone steals your laptop, they could then push to GitHub.
530+
- **IF SECURITY IS REALLY IMPORTANT TO YOU:** Enter a passphrase of your choice and press `Enter`. It's _really_ important that if you enter a passphrase, you write it down somewhere immediately and do not lose/forget it. You will need to enter this frequently.
529531

530532
- `Title for your SSH key`. You can leave it at the proposed "GitHub CLI", press `Enter`.
531533

WINDOWS.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ We highly recommend installing [Windows Terminal](https://apps.microsoft.com/sto
7676
<summary markdown='span'>Windows</summary>
7777

7878
```bash
79-
# replace "your_email@example.com" with your GCP account email
80-
ssh-keygen.exe -t ed25519 -C "your_email@example.com"
79+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
80+
ssh-keygen.exe -t ed25519 -C your_email@example.com
8181
```
8282
</details>
8383

8484
<details>
8585
<summary markdown='span'>MacOS & Linux</summary>
8686

8787
```bash
88-
# replace "your_email@example.com" with your GCP account email
89-
ssh-keygen -t ed25519 -C "your_email@example.com"
88+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
89+
ssh-keygen -t ed25519 -C your_email@example.com
9090
```
9191
</details>
9292

@@ -108,8 +108,8 @@ If you receive this message, you may already have an SSH Key with the same name
108108
To create a separate SSH key to exclusively use for this bootcamp use the following:
109109

110110
```bash
111-
# replace "your_email@example.com" with your GCP account email
112-
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com"
111+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
112+
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C your_email@example.com
113113
```
114114

115115
Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
@@ -480,7 +480,7 @@ We will use the GitHub CLI (`gh`) to connect to GitHub using *SSH*, a protocol t
480480

481481
First in order to **login**, copy-paste the following command in your terminal:
482482

483-
:warning: **DO NOT edit the `email`**
483+
:warning: **DO NOT edit the `email`** — Even though `user:email` looks like a placeholder for your actual email address, it isn't — do not replace it.
484484

485485
```bash
486486
gh auth login -s 'user:email' -w --git-protocol ssh
@@ -492,7 +492,9 @@ gh auth login -s 'user:email' -w --git-protocol ssh
492492

493493
If you already have SSH keys, you will see instead `Upload your SSH public key to your GitHub account?` With the arrows, select your public key file path and press `Enter`.
494494

495-
- `Enter a passphrase for your new SSH key (Optional)`. Type something you want and that you'll remember. It's a password to protect your private key stored on your hard drive. Then press `Enter`.
495+
- `Enter a passphrase for your new SSH key (Optional)`:
496+
- **FOR MOST PEOPLE:** Just press `Enter` to skip. You don't need a passphrase for the bootcamp and it would prompt you every time you use the key. There is a risk, however, that if someone steals your laptop, they could then push to GitHub.
497+
- **IF SECURITY IS REALLY IMPORTANT TO YOU:** Enter a passphrase of your choice and press `Enter`. It's _really_ important that if you enter a passphrase, you write it down somewhere immediately and do not lose/forget it. You will need to enter this frequently.
496498

497499
- `Title for your SSH key`. You can leave it at the proposed "GitHub CLI", press `Enter`.
498500

_partials/ssh_key.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ We highly recommend installing [Windows Terminal](https://apps.microsoft.com/sto
1616
<summary markdown='span'>Windows</summary>
1717

1818
```bash
19-
# replace "your_email@example.com" with your GCP account email
20-
ssh-keygen.exe -t ed25519 -C "your_email@example.com"
19+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
20+
ssh-keygen.exe -t ed25519 -C your_email@example.com
2121
```
2222
</details>
2323

2424
<details>
2525
<summary markdown='span'>MacOS & Linux</summary>
2626

2727
```bash
28-
# replace "your_email@example.com" with your GCP account email
29-
ssh-keygen -t ed25519 -C "your_email@example.com"
28+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
29+
ssh-keygen -t ed25519 -C your_email@example.com
3030
```
3131
</details>
3232

@@ -48,8 +48,8 @@ If you receive this message, you may already have an SSH Key with the same name
4848
To create a separate SSH key to exclusively use for this bootcamp use the following:
4949

5050
```bash
51-
# replace "your_email@example.com" with your GCP account email
52-
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com"
51+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
52+
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C your_email@example.com
5353
```
5454

5555
Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!

macOS.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ We highly recommend installing [Windows Terminal](https://apps.microsoft.com/sto
7676
<summary markdown='span'>Windows</summary>
7777

7878
```bash
79-
# replace "your_email@example.com" with your GCP account email
80-
ssh-keygen.exe -t ed25519 -C "your_email@example.com"
79+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
80+
ssh-keygen.exe -t ed25519 -C your_email@example.com
8181
```
8282
</details>
8383

8484
<details>
8585
<summary markdown='span'>MacOS & Linux</summary>
8686

8787
```bash
88-
# replace "your_email@example.com" with your GCP account email
89-
ssh-keygen -t ed25519 -C "your_email@example.com"
88+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
89+
ssh-keygen -t ed25519 -C your_email@example.com
9090
```
9191
</details>
9292

@@ -108,8 +108,8 @@ If you receive this message, you may already have an SSH Key with the same name
108108
To create a separate SSH key to exclusively use for this bootcamp use the following:
109109

110110
```bash
111-
# replace "your_email@example.com" with your GCP account email
112-
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C "your_email@example.com"
111+
# replace your_email@example.com, this is purely informative and allows you to remember the use of this key
112+
ssh-keygen -t ed25519 -f ~/.ssh/de-bootcamp -C your_email@example.com
113113
```
114114

115115
Your new SSH Key will be named `de-bootcamp`. Make sure to remember it for later!
@@ -478,7 +478,7 @@ We will use the GitHub CLI (`gh`) to connect to GitHub using *SSH*, a protocol t
478478

479479
First in order to **login**, copy-paste the following command in your terminal:
480480

481-
:warning: **DO NOT edit the `email`**
481+
:warning: **DO NOT edit the `email`** — Even though `user:email` looks like a placeholder for your actual email address, it isn't — do not replace it.
482482

483483
```bash
484484
gh auth login -s 'user:email' -w --git-protocol ssh
@@ -490,7 +490,9 @@ gh auth login -s 'user:email' -w --git-protocol ssh
490490

491491
If you already have SSH keys, you will see instead `Upload your SSH public key to your GitHub account?` With the arrows, select your public key file path and press `Enter`.
492492

493-
- `Enter a passphrase for your new SSH key (Optional)`. Type something you want and that you'll remember. It's a password to protect your private key stored on your hard drive. Then press `Enter`.
493+
- `Enter a passphrase for your new SSH key (Optional)`:
494+
- **FOR MOST PEOPLE:** Just press `Enter` to skip. You don't need a passphrase for the bootcamp and it would prompt you every time you use the key. There is a risk, however, that if someone steals your laptop, they could then push to GitHub.
495+
- **IF SECURITY IS REALLY IMPORTANT TO YOU:** Enter a passphrase of your choice and press `Enter`. It's _really_ important that if you enter a passphrase, you write it down somewhere immediately and do not lose/forget it. You will need to enter this frequently.
494496

495497
- `Title for your SSH key`. You can leave it at the proposed "GitHub CLI", press `Enter`.
496498

0 commit comments

Comments
 (0)