1. Project management¶
This week I get to know how to build a personal website, and how to update it gradually using git.
The story¶
The start¶
I started editing the ‘about’ page of my website using gitlab website itself.
Git and Atom¶
First, What is git?
Git is software for tracking changes in any set of files, usually used for coordinating work among programmers collaboratively developing source code during software development. Its goals include speed, data integrity, and support for distributed, non-linear workflows.
So, it is a software, which makes our documentation process easier, by tracking any change in the file, and makes a history for all our work and updates. And we can also use “Branches”, which can be used if you want to work in another track in your project without altering the other track(s).
I downloaded and installed, git application to work in my project in my local computer, and atom application as it have a GUI which makes the work easier for a beginner.
Cloning my repository¶
I cloned my repository using HTTPS,
git clone 'HTTPS link'
Using atoms and pushing the updates¶
I added my repository folder to atoms,
and then was confused: how to use atoms to push the updates I’ve done?
I searched in the web and found that “Ctrl+Shift+P” opens the command line of atoms, and tried to push my updates, and I thought that the processes is done. But there was no update in my website!
After getting some help of my instructors and more search in the web, I’ve got the idea of pushing updates:
1- First I should save my file which I want to push.
2- I should open git in Atoms:
3- Type my name and email of my account in GitLab.
4- Stage the updates I want to push.
5- Write a commit message which helps later as it will tell me why I pushed this change, and click “commit to master”.
6- Click push.
MkDocs¶
MkDocs is a fast, simple and downright gorgeous static site generator that’s geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
I qoute that from mkdocs.org.
So it is a site generator, that is easy to use by the user, without complicated stuff of codes, and then it build it as a html site.
useful links¶
Mkdocs website; it has user guide: mkdocs.org