1. Project management¶
In this assignment, I have worked on creating and editing a website to document all the work that I have done in Fab Academy.
This site was written in Markdown using an Mkdocs theme called “material”, the process of operating, uploading files and editing the site is done via GitLab.
What is GitLab?¶
“GitLab is an open source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more. Self-host GitLab on your own servers, in a container, or on a cloud provider.”
What is Mkdocs and Markdown?¶
-
Mkdocs is a site generator used for documentation of projects, and documentation source files are written in Markdown.
-
Markdown is a Lightweight Markup Language, meaning that it is simple to write and easy to understand. It is suitable for beginners in web development becuase of its simplicity.
How Can I Generate a Site?¶
The route that we choose to take in Fab Academy is by using:
-
GitLab to act as our site server and to be a platform for our site editing.
-
Mkdocs to generate the Site.
-
Markdown to be used as our editing/coding language.
If you are not in Fab Academy, to start editing using Mkdocs in GitLab, follow these steps first before proceeding:
- Install Mkdocs ; here you can find a detailed tutorial:
- Go to GitLab > Create New Project:
- Go to Create Blank Project and add you information, then click create project:
- Go to Web IDE:
- Upload your Mkdocs folder that you installed:
If you are with Fab Academy open your home page in Gitlab then:
Basic steps to edit:¶
Before proceeding, check out this Markdown cheat Sheet before starting:
Then to start editing:
Open Web IDE > go to the file you want to edit
After editing go to Create Commit > Commit to master branch > commit
- To upload an image:
Step 1
Step 2
Step 3
Step 4
Step 5
The result
- To add bullet points:
The result
- To write in bold:
The result
- To change the font/header color and site name:
Step 1:
Step 2:
The results
- To change the site icon:
Step 1:
Step 2:
Step 3:
The result:
- To link social media account:
Step 1:
Step 2:
The result:
To edit the website offline (locally):¶
First you need to install two main softwares:
-
Atom
-
Git Bash
then:
Step 1:
Step 2:
Step 3:
- To upload a YouTube video:
Step 1:
Step 2:
Step 3:
The result:
- To add link:
Final thoughts¶
Using GitLab and working with Web IDE was really simple and user friendly, but I much prefer editing the website offline, the reasons for my preference are:
-
Uploading pictures is much faster and easier.
-
Toggling between tabs/files is more convenient.
The negative points in editing offline are:
- You need to install two main softwares in order to start editing
All in all, offline editing using Atom software is very convenient.