1. Project management¶
This week I worked on my website using Gitlab and started documenting each step I take.
Research¶
Before the first session, I had no background on what gitlab is, how it works, and what Markdown refers to. So, I did some research and watched some helpful YouTube videos.
What is Gitlab?¶
“Gitlab is a service that provides remote access to Git repositories. In addition to hosting your code, the services provide additional features designed to help manage the software development lifecycle. These additional features include managing the sharing of code between different people, bug tracking, wiki space and other tools for ‘social coding’.”
What is Markdown?¶
“Markdown is a lightweight markup language that describes how text should look on a page. HTML is another example of a markup language. Markdown is a style of writing documents that makes it easy to define what the content should look like. It describes headers, text styles, links, lists and so much more.”
What is the meaning of 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. A variety of themes are available.
Website Setup¶
With Fab Academy, my web page was already made in GitLab. I just needed to edit it.
Editing the site¶
First of all, I started customizing the file “mkdocs.yml”. Through the mckdocs file, I changed the site name, description, author, copyright, social media links, and the genral theme following thses steps:
- Go to mckdocs.yml
- Open it in webpage
- Replace the text with your info
- Replace the links with your social media links
- Edit the site theme by changing the color, font, logo, and icon
- Press on “Create commit…” button
- Choose “Create to master branch” then press on “Commit”
Through the “docs” file, we can add texts, images, links, videos, and more. I eddited the site home page and added my information following these steps:
- Go to docs
- Open the index.md in webpage
- Add your information
- Press on “Create commit…” button
- Choose “Create to master branch” then press on “Commit”
- Final result
You can uppload diffenet files and images to be added in the site. Follw these steps:
- Go to docs
- If you want to uplad an images enter the folder named images
- Upload the image\s
- Attach the image to the page you want using the following format