Principles and Practices, Project management¶
This week i worked on my website. Let’s see what i have done
Research¶
I used FabAcademy 2022 students website (Onik Babajanyan), who is also big friend of mine.
Version Control¶
FabAcademy is using Git to manage students works. Git is very good tool to have control on your projects, it gives you opportunity to view what, who and when have made changes, and to see how anybody else in FabAcademy have done projects. To know more about version control and Git you can go here
Get Started¶
For first, I downloaded GIT software from it’s official website
Then created Folder on Desktop. It is my Website Folder
Then right clicked in it and selected Git Bash here
Git Bash and SSH-KEY¶
configured my git by following this steps (I used Onik’s documentation as tutorial)
git config --global user.name “YOUR_USERNAME”
git config --global user.email “your email”
ssh-keygen -t rsa -C "$your email"
Then you must get you ssh key. You must use this command
cat ~/.ssh/id_rsa.pub
Copied my ssh key and pasted it in my GitLab page in SSH-KEY, and clicked “Add Key”
At project page clicked Clone–>Clone with SSH and copied that
Then went back to my GitBash opened in folder and write
git clone (and paste copied link, without scopes)
Here it is! My website folder is ready
✍️ Editing Files and Updating My Website¶
To start editing my FabAcademy website, I installed Visual Studio Code from the official website: https://code.visualstudio.com.
Then, I opened my local website folder with Visual Studio Code. I began editing the .md (Markdown) files using the built-in editor. It was simple and intuitive to use. If I needed help, I referred to the official documentation, but overall, I found the interface quite user-friendly.
🧠 How I Committed and Pushed My Changes¶
After editing my Markdown files, I pushed the changes to my website using Git. Here’s how I did it:
- I opened Git Bash in the website folder.
- I typed
git statusto check what files had been changed. The red lines showed me what modifications I had made. - Then I added the changes by typing:
git add .(Note: there’s a space betweenaddand.) - I committed the changes using a descriptive message:
git commit -m "updated week02 assignment and fixed layout" - Finally, I pushed the changes to the server:
git push
After that, I opened my GitLab project page, where I could see the push in progress:
I waited until the blue clock turned into a green checkmark:
And just like that, my website was updated!
🎨 Customizing My Website¶
I’m using Markdown and the MKDocs template for my site. Initially, I tried using raw HTML, but Markdown was much faster and easier to manage.
To customize the look of my site (like changing the logo, colors, and fonts), I edited the mkdocs.yml file in Visual Studio Code.
Since I play guitar 🎸, I decided to add a guitar icon to my site. I browsed through Font Awesome and found a suitable icon. Then I downloaded it and placed it in my images folder.
To continue working on assignments, I just open the relevant Markdown file in the assignments folder and start editing it.
Updating Agreement 2025¶
As student agreement text have changed a little bit, I need to update it.
Firstly I go to Fabacademy Website where i can find up-to-date agreement text, copy it
then i go to my files, and paste it in my agreement file in website folder.
2025¶
I started this week by updating my ssh keys, bacause they were expired. I used my own documentation to remember every tool and method I used for setting up my website, and also remembering git tools.
As I want this page to stay “tutorial” for setting up FabAcademy website, I don’t want to separate my 2023 and 2025 experiences. I will write here what and how I updated.
I put code examples into Code Blocks, using this type of writing
```
code example
```
Final Project¶
Also I changed my Final Project Idea.
I want to make Guitar tuner, that will tune guitar by itself.
As I play guitar I know that it is hard to tune guitar every time, espesially when you don’t have Phone near you. So my device will recognise and tune every string.
What I Did in 2025¶
In 2025, I continued developing my FabAcademy documentation and workflow. I learned how to edit my site using Visual Studio Code, update content in Markdown, and push changes to the GitLab server using Git. I also customized the appearance of my site by editing the mkdocs.yml file, changing the logo, colors, and font to match my personal style. This helped me better understand how version control, website structure, and static site generation work together in the FabAcademy environment.
Conclusion¶
This week helped me become more confident in managing and customizing my documentation site. I practiced using Git for version control, edited files using Markdown, and explored the MKDocs configuration system. These skills will be essential for presenting my final project and keeping my documentation clear, consistent, and up-to-date throughout the FabAcademy journey.