1. PROJECT MANAGEMENT¶
This week I worked on defining my final project idea and started to getting used to the documentation process.
WHAT IS GIT¶
Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency.
I used the fabacademy website template. Its just a template that defines the style of the page and it’s theme in mkdocs.
This website is built automatically by gitlab every time you edit the files in the docs folder. It does so thanks to Mkdocs a static site generator written in Python. On push it will build using the gitlab-ci.yml file converting mk to html. The mkdocs.yml is used to change the genereration process of the website. For example I have used the mkdocs.yml to change the name of the website.
I installed Git for windows and used git bash to preform operations on the files.
This tutorial helped a lot in setting up git
Setup¶
Install Git
1.Open gitbash and type the following.
To open the gitbash in the folder i want i right click on an empty space in that folder, this is much easier that doing the cd’/c/exetra’ command
2.–-global user.name “Username” Set global Git username
3.–-global user.email “Your email” Set global Git repositories email
4.
SSH is a network protocol, which enables the secure data transmission between two parties within the context of an insecure networkssh-keygen -t rsa -C "Your email"Generated the SSH key
5.cat ~/.ssh/id_rsa.pub Check the ssh key
6.Paste it into gitlab SSH key field
Next to clone the fabacademy template
I used this command to clone it
git clone git@version.oulu.fi:ivansanc/fabacademy_template_site.git
To fetch the changes i used git pull
The procces to update the repository is quite simple now
1.
Adds new or changed files in your working directory to the Git staging area.git add .2.
Commits new and updated files - moving them from the staging queue to your local repositorygit commit -m "description of changes"3.
Uploads all local branch commits to the main remote branch.git push origin main
Creation of web page and documentation¶
MD (Markdown) - Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents. It is formated normally like this
Example md
# Heading1
## Heading2
**Bold 1**
[Mywebsite](https://fablabwebsite-8b0ea6.version-pages.oulu.fi/)
Markdown (.md) → Markdown processor → HTML output
Heading in html vs markdown
<h1>Heading 1</h1>is HTML VS# Heading 1is MD
What it looks like¶
Start ----------------------
Heading1¶
Heading2¶
Bold 1
End -----------------------
SSD (Static site generators) – are software applications that take in templates, components, and a content source, and generate the HTML, CSS, and JavaScript files necessary for a website.
could not get the vid to work at first but read fab lab documentation and basically you need to add and extra ../ to videoes
What i used¶
For the documentation I use MD(Markdown) and for the website I use the university of oulu template. I modify files to make it more like my own page. Thrilling stuff i know but unfortunatelly nothing interesting to report to as of now, will add stuff here if i do change a lot later. Might use a SSD later for better looking pages
Reducing file size of images and videos¶
So it sounds a bit commical but i found that the best video and photo size reducer is telegram, I just drop my videos and photos there and it reduces their size. Since the company wants to save it is in their best interest to have good size compression.
Old size 188 kb
Compressing
New size 55
That is less than 3 times the original I will put both of them here, try to spot the diffrence
first one is the one compressed if you got that you have a keen eye buy you would not be able to spot the diffrence if i didn’t tell you
Also I use this website to reduce the image - https://imagecompressor.11zon.com/en/image-compressor/jpg-size-reducer
The original image was 40 kb
The new one is 20 kb
same with video
