Skip to content

Commit 81b95cb

Browse files
committed
github cloning
1 parent 00a5494 commit 81b95cb

7 files changed

+75
-36
lines changed

content/_index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@ The next few tasks will take you through setting up and getting ready for day 1.
2020
| 03 | [Install PostgreSQL](./docs/3-install-postgresql) |
2121
| 04 | [Install git](./docs/4-install-git) |
2222
| 05 | [Setup GitHub](./docs/5-setup-github) |
23-
| 06 | [Prepare your introduction presentation](./docs/6-intro-presentation) |
24-
| 07 | [Learning resources](./docs/7-learning-resources) |
23+
| 06 | [Clone GitHub Repository](./docs/6-clone-github-repository) |
24+
| 07 | [Prepare your introduction presentation](./docs/7-intro-presentation) |
25+
| 08 | [Learning resources](./docs/8-learning-resources) |

content/docs/5-setup-github.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,8 @@ To get your GitHub username:
2626
2. In the address bar, you should see `github.com/your_username_should_appear_here`.
2727
3. Copy the username value and submit via the form.
2828

29-
{{< button relref="/docs/4-install-git" >}}&laquo; Previous{{< /button >}} {{< button relref="/docs/6-intro-presentation" >}}Next &raquo;{{< /button >}}
29+
We'll periodically check the github usernames and add grant new usernames access to the github repository. So please give up to 2 business days for this to take place.
30+
31+
You will receive an email from Github once you have been granted access.
32+
33+
{{< button relref="/docs/4-install-git" >}}&laquo; Previous{{< /button >}} {{< button relref="/docs/6-clone-github-repository" >}}Next &raquo;{{< /button >}}
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
weight: 1
3+
bookFlatSection: true
4+
title: "6. Clone GitHub Repository"
5+
---
6+
7+
# Clone GitHub Repository
8+
9+
Once you have read access to the course repository, you would need to clone the repository to your local machine.
10+
11+
Before we can do that, we need to setup your local machine's authentication with Github.
12+
13+
There are many ways to do this.
14+
15+
## GitHub Authentication Option 1: SSH
16+
17+
Follow the official docs to setup SSH authentication:
18+
19+
1. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent
20+
2. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account
21+
22+
Using SSH keys is the preferred method by most companies in the industry as it is more secure by making use of public key cryptography. It would be a good chance for you to learn how to do this if you haven't before.
23+
24+
The idea is that you would upload a "public" key to Github and you keep a "private" key in your machine. That means if you leak your public key, it is very difficult for an attacker to brute force and crack your private key (assuming you keep your private key safe and secure). At the time of writing, brute forcing a key of 4096 bits will take years that can even take longer than our lifetimes in this world.
25+
26+
With this method, clone the repository using the ssh method:
27+
28+
```sh
29+
$ git clone [email protected]:Data-Engineer-Camp/<yyyy><mm>-bootcamp.git
30+
```
31+
32+
## GitHub Authentication Option 2: Personal access tokens
33+
34+
Follow the official docs:
35+
36+
1. https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens
37+
38+
This is the simplest and easiest way to manage authentication with Github. However, you should treat your access tokens as passwords because if it gets leaked, an attacker would have full access to your account.
39+
40+
This is the least preferred method, only do this if you are having issues with the previous option.
41+
42+
With this method, clone the repository using the https method:
43+
44+
```sh
45+
$ git clone https://github.com/Data-Engineer-Camp/<yyyy><mm>-bootcamp.git
46+
Username: YOUR_USERNAME
47+
Password: YOUR_PERSONAL_ACCESS_TOKEN
48+
```
49+
50+
## Pulling updates from the repo
51+
52+
After every lecture, we will be uploading the solved student solutions.
53+
54+
To pull updates from the repository:
55+
56+
```sh
57+
git pull origin main
58+
```
59+
60+
{{< button relref="/docs/5-setup-github" >}}&laquo; Previous{{< /button >}} {{< button relref="/docs/7-intro-presentation" >}}Next &raquo;{{< /button >}}

content/docs/6-intro-presentation.md renamed to content/docs/7-intro-presentation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
weight: 1
33
bookFlatSection: true
4-
title: "6. Prepare introduction presentation"
4+
title: "7. Prepare introduction presentation"
55
---
66

77
# Intro presentation
@@ -21,4 +21,4 @@ We encourage you to include photos and keep it fun!
2121
Check out a sample intro presentation [here](https://docs.google.com/presentation/d/1KGSesJoyvl1FqJQTwp1BRd4xpTkL2aeIezWZFFAC-Q4/edit?usp=sharing).
2222

2323

24-
{{< button relref="/docs/5-setup-github" >}}&laquo; Previous{{< /button >}} {{< button relref="/docs/7-learning-resources" >}}Next &raquo;{{< /button >}}
24+
{{< button relref="/docs/6-clone-github-repository" >}}&laquo; Previous{{< /button >}} {{< button relref="/docs/8-learning-resources" >}}Next &raquo;{{< /button >}}

content/docs/7-learning-resources.md renamed to content/docs/8-learning-resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
weight: 1
33
bookFlatSection: true
4-
title: "7. Learning Resources"
4+
title: "8. Learning Resources"
55
---
66

77
# Python
@@ -26,5 +26,5 @@ You should be familiar with basic Command Line Interface (CLI) commands. If not,
2626

2727
- [Command Line Interface basics](https://www.w3schools.com/whatis/whatis_cli.asp)
2828

29-
{{< button relref="/docs/6-intro-presentation" >}}&laquo; Previous{{< /button >}}
29+
{{< button relref="/docs/7-intro-presentation" >}}&laquo; Previous{{< /button >}}
3030

content/docs/_index.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

content/menu/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ headless: true
77
- [3. Install PostgreSQL]({{< relref "/docs/3-install-postgresql" >}})
88
- [4. Install Git]({{< relref "/docs/4-install-git" >}})
99
- [5. Setup GitHub]({{< relref "/docs/5-setup-github" >}})
10-
- [6. Prepare Intro Presentation]({{< relref "/docs/6-intro-presentation" >}})
11-
- [7. Learning Resources]({{< relref "/docs/7-learning-resources" >}})
10+
- [6. Clone GitHub Repository]({{< relref "/docs/6-clone-github-repository" >}})
11+
- [7. Prepare Intro Presentation]({{< relref "/docs/7-intro-presentation" >}})
12+
- [8. Learning Resources]({{< relref "/docs/8-learning-resources" >}})

0 commit comments

Comments
 (0)