Skip to content

1. Project management

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.Git is easy to learn and has a tiny footprint with lightning fast performance.

What is Gitlab?

Gitlab is basically an open-source collaborative software that enables us to preform all the required tasks where also it allows us to run and edit our website easily. Also, it has evolved with strong community support and growth, handling thousands of users on a single server and several.

What is MkDocs?

MkDocs is a static site generator designed for building documentation websites. Written in the Python programming language, MkDocs is an open-source project with a lot of community support.

MkDocs-link

What is Markdown?

Markdown is a markup language used to create formatted text, typically for publishing on the internet. If you’re not familiar, a markup language refers to a system that includes syntax elements that adjust the appearance of, but do not appear in, the final document.

Markdown-link

What are the benfits on MkDocs ?

MkDocs uses a YAML configuration file and can optionally use themes to easy change the look-and-feel of the documentation output. In addition to the easy configuration via a YAML file and the drop-in themes, MkDocs also has a wonderful search feature. Search is often not possible out of the box in other static site generators. With MkDocs search can easily be added without plugins or code changes to the static site generator.

resources of MKDocs

The official Getting Started with MkDocs is likely the best place to go when you are just getting set up with your first site that uses this project ()

first day

We started by creating account in Fablab and getting access to GitLab and running the pipeline to start make changes on our site GitLab created by Linus Torvalds. It is a cloud server that will enables you to run your site and edit it using markdown language. It creates multiple versions so that in case error happens you can return to that specific error to change it also if more than one person works on it by creating the best version merging all to suitable updated change.

How to Edit the Website?

First of all, we have to create an account in Fablab and getting an access to Gitlab.

After signing in, The following steps can be followed in order to edit the website:

1- Click on the project to get into your site for Fab Academy

2- Click on the file that you want to edit and then press on (Open in Web IDE)

changing the color and name

this pictuer show us how to change the color

this pictuer show us how to change the name

change the theme

we should go to mkdocs.yml in getlab and change it, before that we can use this link https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors to try the colors. also you can change scheme, primary and accent

After finishing the edit you have to make sure that you click on (Create commit > commit to master branch> commit).

To upload an images

Go to the file that you whant to upload the image on it, for example i will choose image/week01

About gitlab

GitLab Inc. is an open-core company that provides GitLab, a DevOps software package that combines the ability to develop, secure, and operate software in a single application.The open source software project was created by Ukrainian developer Dmitriy Zaporozhets and Dutch developer Sytse Sijbrandij.GitLab Inc, was considered the first partly Ukrainian unicorn valued more than $1 billion in 2018.

Since its founding, GitLab has been centered around remote work.GitLab is the largest all-remote company in the world.GitLab has an estimated 30 million registered users, with 1 million being active licensed users.

The GitLab software was originally written in the Ruby programming language, with some parts later rewritten in the Go programming language.Initially, it was a source code management solution to collaborate within a team on software development that evolved to an integrated solution covering the software development life cycle, and then to the whole DevOps life cycle. The current software technology used includes Go, Ruby on Rails, and Vue.js.

It follows an open-core development model where the core functionality is released under an open-source (MIT) license while the additional functionality such as code owners, multiple issue assignees, dependency scanning and insights are under a proprietary license

Final resulet

Git

Gitlab

MkDocs

Markdown


Last update: September 5, 2022