Skip to content

Commit e087321

Browse files
authored
Update ssh explanation & fix venv path (#298)
## What <!--- Write the change being made with this pull request ---> ## CHECKS ⚠️ Please make sure you are aware of the following. - [ ] **The changes in this PR doesn't have private information
2 parents f8b59f1 + d07d033 commit e087321

File tree

5 files changed

+16
-6
lines changed

5 files changed

+16
-6
lines changed

document/01-git.en.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,16 @@ In this step, we will learn how to use Git and GitHub.
3434
```
3535

3636
## Use basic commands in Git
37+
0. Follow the GitHub documentation to setup SSH-key.
38+
- [Generate new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent?platform=mac)
39+
- [Add a new SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
3740

38-
1. **Clone** `https://github.com/<your github id>/mercari-build-training` onto your local using the following command.
41+
42+
1. **Clone** `https://github.com/<your github id>/mercari-build-training` onto your local using the following command. Follow the below image to get the ssh url.
43+
![clone-ssh.png](./assets/clone-ssh.png)
3944
```shell
4045
$ cd <your working space>
41-
$ git clone https://github.com/<your github id>/mercari-build-training
46+
$ git clone git@github.com:<your github id>/mercari-build-training.git
4247
```
4348

4449
**:bangbang: Caution**

document/01-git.ja.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,17 @@
3434
```
3535

3636
## Gitの基本コマンドを使う
37+
0. SSH-keyのセットアップ
38+
GitHubの公式ドキュメントに従ってSSH-keyをセットアップします。
39+
- [新しいSSHキーを生成する](https://docs.github.com/ja/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
40+
- [新しいSSHキーを追加する](https://docs.github.com/ja/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
3741

3842
1. `https://github.com/<your github id>/mercari-build-training`**clone**
39-
します。 cloneすると、github上のリポジトリを自分のローカルにDownloadできます。
43+
します。 cloneすると、github上のリポジトリを自分のローカルにDownloadできます。以下の画像に従ってsshのurlを取得できます。
44+
![clone-ssh.png](./assets/clone-ssh.png)
4045
```shell
4146
$ cd <your working space>
42-
$ git clone https://github.com/<your github id>/mercari-build-training
47+
$ git clone git@github.com:<your github id>/mercari-build-training.git
4348
```
4449

4550
**:bangbang: 注意**

document/02-local-env.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ $ python3 -m venv .venv 
3737

3838
# Activate virtual environment
3939
$ source .venv/bin/activate # for Mac or Unix user
40-
$ ./venv/Scripts/activate # for Windows user
40+
$ .venv/Scripts/activate # for Windows user
4141

4242
# Install required library
4343
$ pip install --upgrade pip setuptools wheel

document/02-local-env.ja.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ $ python3 -m venv .venv
3939

4040
# 仮想環境をアクティベートする
4141
$ source .venv/bin/activate # Unix / Macの場合
42-
$ ./venv/Scripts/activate # windowsの場合
42+
$ .venv/Scripts/activate # windowsの場合
4343

4444
# 今回使うPythonのパスを確認する。
4545
$ which python

document/assets/clone-ssh.png

376 KB
Loading

0 commit comments

Comments
 (0)