external/contribute/mirror-fork/mirror-fork.md

@@ -5,6 +5,8 @@ shortcut: contribute:mirror-fork
 redirect_from:
   - /cards/contribute:mirror-fork
   - /external/cards/contribute:mirror-fork
+  - /contribute/mirror-fork
+  - /external/external/contribute/mirror-fork/
 ---
 # Mirror fork automatically
 
@@ -13,7 +15,10 @@ you should follow the follow simple steps.
 
 1. Go to `Settings > Repository` (bottom left of the screen)
 2. Expand the section on `Mirroring repositories`
-3. In the field `Git repository URL`, enter the SSH clone address from the main repository. In case of this repository, the address is `ssh://git@gitlab.lcsb.uni.lu:8022/R3/howto-cards.git`
+3. In the field `Git repository URL`, enter the SSH clone address from the main repository. 
+
+    <img src="img/img1.png">
+
 4. Select `Mirror Direction` as `Pull`
 5. Click on `Detect Host Keys`
 6. `Authentication method` should be selected as `SSH public key`
@@ -25,9 +30,10 @@ You will see an entry in the table below the blue button. Often, there is an err
 
     <img src="img/copy-ssh-key.png" height="80">
 
-2. Then, browse to your profile picture (top right) and click on `Preferences`
-3. On the left of the page, click on `SSH keys`
-4. Paste the key (using CTRL+V or CMD+V) into the SSH field
-5. Click on `Add key`
+2. Then, browse to your profile picture (top left corner) and click on `Preferences`
+3. On the left of the page, click on `SSH Keys`
+4. Click on the 'Add new key' button on the SSH keys table
+5. Paste the key (using CTRL+V on Windows or CMD+V on macOS) into the SSH key field
+6. Click on `Add key`
 
 Now, the synchronization of the fork should perform successfully. You can click on the sync button or wait a few minutes. :white_check_mark:

external/contribute/review/review.md

+---
+layout: page
+permalink: /external/contribute/review/
+shortcut: contribute:review
+redirect_from:
+  - /cards/contribute:review
+  - /external/cards/contribute:review
+  - /contribute/review
+  - /external/external/contribute/review/
+---
+
+# Reviewing in Git
+
+Before a branch can be merged to the *develop* branch, a review is often requested. If you have been desginated as the reviewer of a merge request, it means that your approval is needed to be able to proceed with the merge of the branch.
+
+To do the review, click on the link sent by GitLab. You will be redirected to GitLab and directly on the merge request.
+
+You can see the name of the merge request (*LCSB-SOP-ADM-001*), and the history of the merge request in *Overview*. 
+
+- Click on **Changes**
+
+<div align="center">
+<img src="img/img1.png">
+</div>
+
+- On the left side is the list of the files impacted by this merge request. 
+
+A red square next to a file means that the file has been removed.
+
+An orange one means that the file has been modified.
+
+A green one means that the file has been added.
+
+<div align="center">
+<img src="img/img2.png">
+</div>
+
+- Click on the **.md file**
+
+    - *Red sections* have been deleted or modified
+    - *Green sections* are the modified version of the red sections or are newly added
+
+    <div align="center">
+    <img src="img/img3.png">
+    </div>
+
+    - If there was no change compared to the previously approved the section will not be highlited. If several lines have not been impacted, they might be collapsed. To uncollapse the lines, click on the arrows.
+
+    <div align="center">
+    <img src="img/img4.png">
+    </div>
+
+To have a more readable view, with the pictures integrated, click on the 3 dots on the right side and click on *View files @ xxxxx*.
+
+<div align="center">
+<img src="img/img5.png">
+</div>
+
+- To make a comment on a line, place your mouse on the line number and click on the bubble that appears on the left side. 
+
+<div align="center">
+<img src="img/img6.png">
+</div>
+
+- Make your comment on the comment section and click on **Start a review** or on **Add comment now**. Clicking on *"Start a review"* will allow you to compile several comments before an email is sent to the assignee when you will click on **Finish review**. Clicking on *"Add comment now"* will send an email to the assignee for every comment.
+
+Clicking on the first icon will allows you to directly suggest a change that the assignee will be able to accept or not.
+
+<div align="center">
+<img src="img/img9.png">
+</div>
+
+<div align="center">
+<img src="img/img8.png">
+</div>
+
+When all the threads are resolved, you will be able to **Approve** the merge request and the repository maintainer will be able to proceed with the merge.
\ No newline at end of file

external/contribute/ssh-key-generation/ssh-key-generation.md

+---
+layout: page
+permalink: /external/contribute/ssh-key-generation/
+shortcut: contribute:ssh-key-generation
+redirect_from:
+  - /cards/contribute:ssh-key-generation
+  - /external/cards/contribute:ssh-key-generation
+  - /contribute/ssh-key-generation
+  - /external/external/contribute/ssh-key-generation/
+---
+
+# Key-based Authentication on GitLab
+
+Key-based authentication allows GitLab users to identify their device once on their account and avoid having to log in via their credentials every time. GitLab uses SSH protocol to communicate with Git.
+
+SSH uses a public and a private key:
+- The public key must be registered in GitLab, where it "identifies" your device.
+- The private key must stay secret and preferably you should only keep it on a single device. The private key is the only key that can be used to authenticate your identity against the public key uploaded to GitLab -- if it becomes public, anyone can impersonate your identity and thus use your GitLab account. **Make sure you do NOT upload the private key anywhere by accident, not even to GitLab.**
+
+# Prerequisites
+
+To use SSH, one of the following must be installed on your device:
+
+- The OpenSSH client, which comes pre-installed on GNU/Linux, macOS, and [Windows 10 via Powershell or WSL](https://docs.gitlab.com/ee/user/ssh.html#use-ssh-on-microsoft-windows).
+- SSH version 6.5 or later. Earlier versions used an MD5 signature, which is not secure.
+
+To view the version of SSH installed on your system, run the following command in your terminal (on Linux or macOS) or Git Bash (on Windows):
+
+```
+ssh -V
+```
+
+# Key Generation
+
+> :warning: Please note that the steps below describe SSH key generation. If you already have one, **your existing key may be overwritten.**
+
+1. Start a terminal
+
+2. Type the following command at the command prompt and run it after replacing your firstname and lastname:
+  ```
+  ssh-keygen -t ed25519 -C firstname.lastname@uni.lu
+  ```
+3. Accept the suggested filename and directory
+
+4. Press `Enter` to continue. Defining a password is not necessary and can be skipped. 
+
+5. To copy the contents of your public key file into the clipboard, run the following command:
+
+    - For macOS:
+    ```
+    tr -d '\n' < ~/.ssh/id_ed25519.pub | pbcopy
+    ```
+    - For Windows:
+    ```
+    cat ~/.ssh/id_ed25519.pub | clip
+    ```
+
+# Saving the SSH Key on GitLab
+
+Once the content of the public key is copied in the clipboard, you need to register it with your GitLab account.
+
+To save your key to your account:
+
+1. Log in to GitLab using your LUMS account
+
+2. Navigate to the `Preferences` menu
+
+    ![preferences](img/preferences.png)
+3. User settings will be displayed on the left-hand side menu. Click on the `SSH Keys` option
+
+    ![ssh-menu](img/ssh-menu.png)
+
+4. On the `SSH Keys` page, click on `Add new key` button to add your public key
+
+    ![new-key](img/new-key.png)
+
+5. Paste your new key into the `Key` box, name the key and save it by clicking the `Add key` button
+
+    ![key-details](img/key-details.png)
+
+# Troubleshooting
+
+Please refer to the [GitLab Docs](https://docs.gitlab.com/ee/user/ssh.html#troubleshooting) or [create a ticket](https://service.uni.lu/sp?id=sc_cat_item&table=sc_cat_item&sys_id=c1d98bacdb9cf810ca53454039961917) for further assistance regarding the key-based authentication.