1. Project management and documentation#

This week I learned what Markdown is and how to use it and I also learned how to resize an image with the command line using ImageMagick.

GitLab Repository#

Being in computer science, I have already had to manage GitHub/GitLab repository on VSCode repositories for several group projects so I have not learned anything about this part of the work. To manage my repository I used VSCode which has very practical features that allow very simple management of the repository.

Clone#

To clone a GitHub/GitLab repository on VSCode, you need to click on “Clone Repository”, then copy the link of your repository and select the folder where you want to clone it.

The IDE will automatically open the repository folder so you can work on it directly.

Add File#

To add a file to your repository, simply copy/paste your file into your repository folder and it will be automatically added.

Commit#

Once you are done editing your repository, you need to commit it. To do this, simply give your commit a name that describes your change and then validate it.

Push#

The first time you push your repository you need to add your account information in the hidden file “.git/config”.

Line to add :

[user]
    name = "Your Username"
    email = "Your E-mail"

Once this step is done you will be able to push freely by simply clicking on the push button.

Markdown#

Markdown was a completely new thing for me, so I had to learn how to use it. It’s pretty easy to learn, but the tricky part is trying to get a specific way to display your elements, since you have to use HTML (which is much harder to learn). Luckily, I was able to use ChatGPT to fix these issues.

Rendering#

VSCode have an enormous variety of extension. One of them is Markdown All in One and it helps a lot in the creation of a page using markdown

By pressing Shift + Ctrl + V, a new window opens with the rendering of your Markdown file.

Reduct Image Size#

Reducing image sizes is important because they should not be too heavy for a website. Having a 4k image will only slow down the page loading and having a maximum resolution of 1080p is more than enough.

I used ImageMagick to lower the resolution and change the format of my image. To do that you have to open a terminal in the file where the picture is located and type the command:

magick convert -resize "new width"x "input image name" "output image name"

(Here it says that the command is deprecated but still works fine.)

Project management#

Spiral development involves progressing in stages on several tasks simultaneously, in order to avoid leaving parts of the project behind. Each cycle allows progress to be assessed, risks to be managed, and objectives to be adjusted to ensure a continuous and balanced evolution of the project.