Skip to content

1. Project management and documentation

The first week of Fabricademy was about getting to know better how the course works and some pratical information. We also had a lot of exemples of projects developed by the students in previous years and lots of inspiration.

The assignments of this week were about learning how to edit the webpage in Gitlab and building and customizing my own page. We also were encouraged to add references and interests related to the topics of the course. I found it quite hard to follow the GitLab tutorials but when I stopped to read the handbook and to take a look on how do other students were building and editing their pages, it got easier. I have never used Gitlab or the Markdown language before. The Markdown tutorial helped a lot!

Adding pictures, gifs and videos is an important step for ilustrating the documentation. One important thing is to make the pictures smaller so it wont make your website heavy, wich could make it stop working. One thing that I did was to make an "action" on photoshop, it resizes automatcally to 300px high my images and saves on a "ready for the website" folder. I use photoshop to edit the images because I'm already used to it. If you're looking for an free open source photo editor there's Gimp and for vectorial images, there's Inkscape.

Code for pictures:

![](./images/archivename.jpg)

Code for picture in folder inside image folder:

![](../images/foldername/archivename.jpg)

For adding gifs, we have to use a mp4 to gif converter and then a gif compressor. I've been using ezgif

For adding youtube or vimeo videos, you can link it to an image, following this code:

[![IMAGE ALT TEXT HERE](https://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg)](https://www.youtube.com/watch?v=YOUTUBE_VIDEO_ID_HERE)

The Customization part of the website - changing colour, typewrite, images, etc - is all in the mkdocs.yml folder inside the editing mode (web IDE).

Another tip is to enter in other Markdown pages from the colleagues to check what they've done, get tips and codes from their "editing mode" page in markdown. You can do that by clicking in your own gitlab page and clicking on "students" or even "textile academy" if you want to check pages from previous years.

My previous projects, some inspirations and motivations are in my home page and along the website :) I also have my own website, but it is in process, also.


Last update: 2023-05-17