Week 1. Principles and practices¶
Week one’s assignment involed getting familiar with Git something i’ve long been aware of but for some reason avoided up until now. The 2nd step was to build our own personal webpage which we will use to document out Fab Academy journey. In week 1 the task was to populate this webpage with ‘about me’, describing out final project idea whilst documenting the very process’s and skills one must use in order to achive this. Finally we needed to do a initial sketch of our final project
GIT¶
Git is a distributed version control sytem, rather than all the verison history of a software being in one place, with Git, every developers wokring copy of the code is also a repository that contains the full history of changes. In addition to the advantages of its distributed architecture Git has also been designed with performance, security and adaptibility at its core.
How To install GIT & Create SSH-KEYs¶
-
Install Git (Git Installation)
-
Establish a secure connection between my local computer and Gitlab.
To set up a Git Environemtn i used the following commands
git config -- global user.name "my-username"
git config -- global user.email "my-email"
These credentials relate to the ones you use on GitLab and are used to I.D yourself to Gitlab. To Generate a SSH key the following command is used
ssh-keygen -t ed25519 -C "my-email"
Now the keys will be genrated and you need to specify where you want them on your local drive
Generating public/private ed25519 key pair.
Enter file in which to save the key (/home/user/.ssh/id_ed25519):
Now you will be prompted with whether you want to add an optional passphrase for the keys. Now you need add the key on Gitlab in the User Settings page:
Now I cloned my Repository on gitlab in order to work locally on my website. This Leads into the next of using Windows Visual Studio Code to do this.
Using Git with Visual Studio Code¶
The main proceses are CLONE, ADD, COMMIT and PUSH. In Visual studio code this is done by:
-
Clone: > Clone from URL
-
Stage Changes: to add changes/updates to a partciuler file.
-
Commit: captures a snapshot of the project’s currently staged changes. .
-
Push: This is done to add local commits to the online Repo.
Website V1¶
Here is my first web page
MkDocs¶
I used the MkDocs template in from the FabAcademy GitLab, MkDocs is a documentation generator that allows you to wrtie documents in Markdown, to preview your document as you wirte it and eaislt coustomize it with themes and extensions. I added the template to my local repo where by exisitng site was located and simply replaced the files here witht the new template.