From c90abd8203e80979f66523ff9215d1cfbf2c6aaa Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rene=20Hamp=C3=B6lz?= <hampoelz@student.tugraz.at>
Date: Sat, 19 Oct 2024 10:39:43 +0200
Subject: [PATCH] docs: Add more references to ssh-agent guide
---
README.md | 2 ++
docs/devcontainer.md | 3 +++
docs/git.md | 8 ++++----
docs/ssh.md | 8 ++++++++
4 files changed, 17 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index ed113a2..60e340c 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,8 @@ The best way to get started is to read the following links step by step, everyth
- [MacOS](docs/git.md#macos)
- [Linux](docs/git.md#linux)
2. [SSH](docs/ssh.md)
+ - [Starting the the SSH Agent](docs/ssh.md#starting-the-the-ssh-agent)
+ - [Generating a new SSH key](docs/ssh.md#generating-a-new-ssh-key)
3. [Docker](docs/docker.md)
- [Windows](docs/docker.md#windows)
- [MacOS](docs/docker.md#macos)
diff --git a/docs/devcontainer.md b/docs/devcontainer.md
index 2807ea0..792aa8c 100644
--- a/docs/devcontainer.md
+++ b/docs/devcontainer.md
@@ -38,6 +38,9 @@ To use the container the VS Code **Dev Container** extension is required:
### Open your assignment in the container
+> **IMPORTANT:** Make sure that you have set up the SSH authentication agent.
+> You can find all the necessary information in our guide [Starting the the SSH Agent](ssh.md).
+
First you have to clone your assignment repository from [TU Graz GitLab](https://gitlab.tugraz.at/). You can choose whether you want to clone with Git or with VS Code, choose the one you prefer.
1. Open your OOP1 assignment repository in [TU Graz GitLab](https://gitlab.tugraz.at/)
diff --git a/docs/git.md b/docs/git.md
index ce59e04..560479b 100644
--- a/docs/git.md
+++ b/docs/git.md
@@ -6,7 +6,7 @@ You should already have a basic understanding of this from other courses.
If you need a quick refresher on this topic, here is a introduction from the largest Git hosting website **GitHub**: https://www.youtube.com/watch?v=r8jQ9hVA2qs
-If you already have Git installed and set up on your system, you can skip this step and continue with [Setting up an SSH key pair](ssh.md).
+If you already have Git installed and set up on your system, you can skip this step and continue with [Starting the the SSH Agent](ssh.md).
## Table of contents
@@ -18,7 +18,7 @@ If you already have Git installed and set up on your system, you can skip this s
Download and install Git from https://gitforwindows.org/.
-Next steps: [Setting up a SSH key pair](ssh.md)
+Next steps: [Starting the the SSH Agent](ssh.md)
## MacOS
@@ -28,10 +28,10 @@ Simply type `xcode-select --install` into the terminal.
There are also several other ways to install Git on MacOS, which are described in the official documentation: https://git-scm.com/downloads/mac
-Next steps: [Setting up a SSH key pair](ssh.md)
+Next steps: [Starting the the SSH Agent](ssh.md)
## Linux
Git may already be installed depending on your distribution, if not, you just have to install the `git` package with your package manager.
-Next steps: [Setting up a SSH key pair](ssh.md)
+Next steps: [Starting the the SSH Agent](ssh.md)
diff --git a/docs/ssh.md b/docs/ssh.md
index f234d11..dc53627 100644
--- a/docs/ssh.md
+++ b/docs/ssh.md
@@ -25,12 +25,16 @@ To be able to clone your project from the [TU Graz GitLab](https://gitlab.tugraz
Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
+> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
+
### MacOS
When using MacOS, the SSH authentication agent should be started automatically.
Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
+> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
+
### Linux
#### Bash & ZSH
@@ -50,6 +54,10 @@ Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
fi
```
+Next steps: [Generating a new SSH key](#generating-a-new-ssh-key)
+
+> If you have already generated an SSH key, keep in mind to add it to the ssh-agent.
+
#### Fish
1. Install the [Fundle plugin manager](https://github.com/danhper/fundle).
--
GitLab