Skip to content

2. Project Management

Requirements:

  1. plan and sketch a potential final project
  2. work through a git tutorial
  3. build a personal site in the class archive describing you and your final project

Main Points

To begin, I had to download Git and GitBASH in order to be able to apply proper version control. After making an account at GitHub (as the GitLab accounts were not ready) I generated an ssh key using the command:

ssh-keygen -t ed25519 -C “[EMAIL]”

and my associated email. The key was then added to my account in Github With this I will be able to pull, commit, and clone straight from my GitBASH terminal without having to go through the website. Since I had never studied using HTML for web design before this I opted to use the Markdown language and MKDocs as it allowed me to produce readable webpages using very basic syntax. I used the useful tutorial pictured below to get a start on writing mkdocs: The template provided to us by Engineer Hashem helped me make a start, I used the website below to get a quick grasp on Markdown syntax. I already had python and pip installed and up-to-date on my PC, so there was no need to do anything to set that up I used pip to install MKDocs

pip install mkdocs

then installed the specific theme for my website: material

pip install mkdocs-material

I used ATOM in order to edit the template and write the Markdown code, it is a simple text editor compatible with the language which I found to be helpful. I created a repository under my name and temporarily used it while my GitLab account was being prepared, while GitHub would not serve the website properly as it was not configured for GitHub this was fine as I could use the code:

mkdocs serve

In order to view my website and confirm how it looks. Once my GitLab account was released I was able to simply move my work by cloning the GitLab repository, replacing the existing documents with mine, then pushing my work onto it.

Problems and Errors

  1. The first error I faced was while attempting to serve my website using the mkdocs command

    This was fixed very simply by following the error and using the code as referenced from FabLAb Kannai

    install pip install mkdocs-git-revision-date-localized-plugin

  2. Second issue faced was during my first Push attempt, which lead to a pipeline failing as can be seen in the history

    Following the error this was because I had removed ‘Requirements.txt’ from the root folder.
    To correct this I added it back and successfully Pushed my website to GitLab

Last update: February 8, 2022