|
|
:imagesdir: ../images
|
|
|
:toc:
|
|
|
|
|
|
== Installing the Tools
|
|
|
|
|
|
[horizontal]
|
|
|
Install Git:: (the versioning control system we use) +
|
|
|
https://git-scm.com/download/win
|
|
|
|
|
|
Install VSCode:: an all-in-one open-source text editor that makes life a lot easier +
|
|
|
https://code.visualstudio.com/download
|
|
|
|
|
|
== Configuring VSCode
|
|
|
* In the VSCode menu bar -> View -> Extensions
|
|
|
|
|
|
image::extensions.png[]
|
|
|
|
|
|
* Search for Asciidoc & install it. This provides preview and syntax highlighting for asciidoc files
|
|
|
|
|
|
image::install_asciidoc.png[]
|
|
|
|
|
|
|
|
|
== Setting up a Secure SSH connection to Gitlab
|
|
|
|
|
|
TIP: To ensure you don't have to enter your login details every time you want to interact with the repository add an SSH key to your account
|
|
|
|
|
|
. In a powershell window, enter the following:
|
|
|
|
|
|
+
|
|
|
[source,git]
|
|
|
----
|
|
|
ssh-keygen -t ed25519 -C "YourEmail@address.com"
|
|
|
----
|
|
|
|
|
|
.. Use the suggested path
|
|
|
.. Entering a password is optional and leads to additional steps every time you connect to the remote so I recommend against it
|
|
|
|
|
|
|
|
|
. In a Powershell window enter
|
|
|
|
|
|
+
|
|
|
[source,git]
|
|
|
----
|
|
|
~/.ssh/id_ed25519.pub | clip
|
|
|
----
|
|
|
|
|
|
.. If this doesn’t work, open the file you created in a text editor and copy the whole text
|
|
|
|
|
|
|
|
|
. Add the generated key to https://code.asam.net/profile/keys[Gitlab] - Paste the key copied in step 2, give it a title and then click "Add Key"
|
|
|
|
|
|
== Configuring Git
|
|
|
* To make sure your commits match your name and email details a one time configuration is necessary
|
|
|
* In a powershell or terminal:
|
|
|
|
|
|
+
|
|
|
[source,git]
|
|
|
----
|
|
|
git config --global user.name "FIRST_NAME LAST_NAME"
|
|
|
git config --global user.email "MY_NAME@example.com"
|
|
|
----
|
|
|
|
|
|
== Setting up VSCode
|
|
|
|
|
|
== Cloning a Repository for the First Time
|
|
|
NOTE: This only needs to be done once to obtain a local copy.
|
|
|
|
|
|
. Find the repository url on the website and copy the git url
|
|
|
|
|
|
. Open Command Palette (Ctrl+Shift+p), type "Git: Clone" then press Enter
|
|
|
|
|
|
. Enter the git url you copied earlier, Press enter
|
|
|
|
|
|
. Select the folder on your pc where you want to save the repository
|
|
|
|
|
|
image::gitclone.gif[] |