1. Project management¶
I spent this week working on my website page as well as understanding the documentation process.
GitLab¶
what is GitLab?¶
” GitLab is an open source code repository and collaborative software development platform for large DevOps and DevSecOps projects. GitLab is free for individuals. GitLab offers a location for online code storage and capabilities for issue tracking and CI/CD.”
GitLab set-up¶
In order to access a repository that had been created for me, I first created an account on GitLab. We got to see how to work with GitLab, and as I had previously dealt with GitHub, I found it to be easy to use.
Because the web page had already been created for us and was a ready template that we were able to use, all I had to do was update it and add my information, and then I could quickly document my assignment over it.
Mcdocs¶
MkDocs is used on our website.
“MkDocs pages must be authored in Markdown, a lightweight markup language which results in easy-to-read, easy-to-write plain text documents that can be converted to valid HTML documents in a predictable manner.”
Writing in Markdown is almost as easy as writing in a standard text editor, which is the whole idea of not having to deal with HTML.
Website¶
-
Open mckdocs.yml and chaned the site name, links at the footer, colors, logo, and others.
-
docks file >> index.md, I edited the home page of the website.
-
To write in the weekly assignments, go to docs >> assignments >> week.No and write what I did.
-
To display any images on the website, I first have to upload the image at docs >> images >> week No. and then linked to it at the markdown file.
