02. Project Management¶

Read, sign (add your name to) the student agreement and commit it to your repo
Work through a git tutorial.
Build a personal website in the class archive describing yourself and your final project.

Set-up¶

Software & Downloads¶

Ubuntu MK docs Linux

Steps¶

SSH key clone

Attempt One¶

I initially started making updates to the site directly via right-click inspect (web IDE), always commit & push to main branch, git pull to sink with local repository. Whilst a valid process for updating its not best practice for version control, especially when your new to the process. As such I made some critical errors, which I needed help from Dani to fix

Attempt Two¶

Simple Changes¶

I started with opening the mkdocs file & updating the site to have my name in the banner & change the base colours. I did this by opening the mkdocs.yml file & changied the colours to one of the options listed on the website linked in the file, then pushed these changes to git.

$ cd freya-robinson/
$ git status
$ git commit -m "colour"
$ git push
$ git diff
$ git status
$ git diff
$ git add docs mkdocs.yml
$ git commit -m "C"
$ git push

changing colour attempt

¶

Updating files¶

Open Ubuntu $ cd freya-robinson/ to change into relevant directory. Then can make changes to git using commands below

$ git add docs mkdocs.yml
$ git commit -m "ID info"
$ git push

Launch Local Site¶

After typing ‘mk serve’ into my terminal I was prompted to install mkdocs using ‘sudo apt install mkdocs’ & to enter the password id assigned during set up

freya@FREYA-GWH9CK3:~/freya-robinson$ mkdocs serve
Command 'mkdocs' not found, but can be installed with:
sudo apt install mkdocs
freya@FREYA-GWH9CK3:~/freya-robinson$ sudo apt install mkdocs
[sudo] password for freya:
Reading package lists... Done
Building dependency tree... Done
Reading state information... Done

This prompted a lot of lines of installing/set up followed with a request for y/n user approval

Formatting¶

Images¶

I compressed this screenshot (changing colour attempt) using my computers built in editing features before adding it to images under a new folder for ‘week02’ in my directory. Then inserted the image on the webpage using ![](../image/filepath.jpg)

Videos¶

Use the below commands to change paragraph style & add footers to images/videos

<p style="font-size: 11px"> 
    footer description 
</p>
##

Bullets¶

-
-
    -

Sub quote¶

example

¶

Key Terms¶

Example website URL: fabacademy.org/2026/labs/my-lab-name/students/my-name-here
Example repository URL: gitlab.fabcloud.org/academany/fabacademy/2026/labs/my-lab-name/students/my-name
SSH Key: ssh -T git@gitlab.fabcloud.org
Fablabs.io: Main login
Mattermost: Chat server
Nueal: Evaluation/assignments
Gitlab: project documentation
Gitlab Pages: Website hosting
Repository: Store documentation of commits/change history
Working directory: Actual files
Web IDE (F12 or right click inspect): Split screen online edit
Gitlab Ci: continuous integration/compiles website
SSH Key: Communication between git server & local computer