1. State of the art, project management and documentation¶
Presentation¶
My name is María José Rivas, and I am very interested in becoming part of Fabricademy because I find the intersection of technology, biology, and design fascinating. I am passionate about exploring how innovative materials and techniques can be integrated into sustainable solutions that positively impact our society and the environment. I believe that Fabricademy is the ideal space to develop my knowledge and skills and to collaborate with a global network of experts and creatives who share the vision of a more sustainable future. I am excited about the opportunity to immerse myself in this ecosystem of learning and innovation and to contribute my creativity and commitment to developing meaningful and transformative projects.
how to document?¶
Documentation is a fundamental aspect of Fabricademy because it serves as a bridge between individual creativity and collective knowledge. In such an innovative and interdisciplinary program, thorough documentation allows students to capture every step of their learning journey—from ideas and experiments to successful outcomes and challenges encountered along the way. This record not only enables students to reflect on their growth but also transforms each project into a valuable resource that future participants, collaborators, and the wider community can learn from and build upon.
Furthermore, detailed documentation promotes a culture of transparency and accessibility in open-source environments. By sharing insights, methods, and results, Fabricademy participants contribute to a global knowledge base that pushes the boundaries of sustainable design, biofabrication, and digital fabrication. In essence, documenting work is not only a way to track personal progress but also a powerful tool for driving innovation and inspiring others within and beyond the Fabricademy network.
Documentation¶
Introduction to Markdown
Markdown is a lightweight markup language designed to simplify the process of formatting text for web-based documents. Created by John Gruber in 2004, Markdown provides an easy-to-read and easy-to-write syntax that converts plain text into structured HTML content. Its simplicity and versatility have made it a popular choice for developers, writers, and content creators alike.
At its core, Markdown uses plain text characters—such as asterisks, hashes, and underscores—to indicate formatting elements like headings, bold text, italicized text, lists, and more.
For example, a single # creates a heading, while wrapping text in ** makes it bold. This intuitive approach eliminates the need for complex HTML or CSS when creating well-structured documents.
Why Use Markdown? Ease of Use: Markdown’s syntax is simple and quick to learn, allowing users to focus on content rather than formatting. Versatility: It’s supported by many platforms, including GitHub, GitLab, and Jekyll, making it ideal for documentation, README files, blogs, and presentations. Portability: Markdown files are plain text, ensuring compatibility across devices and editors. Extensibility: It can be extended with tools like GitHub Flavored Markdown or integrated with frameworks to generate HTML, PDFs, or other formats.
Basic Markdown Syntax
Below are some common examples for modifying text:
Headings
<# Heading 1>
<## Heading 2>
<### Heading 3>
Bold text
<**This is bold text**>
<__This is also bold text__>
Italic text
<*This is italic text*>
<_This is also bold text_>
Bold and Italic text
<***This is bold and italic text***>
<___This is also bold and italic text___>
Unordered Listst
<- Item 1>
<- Item 2<
< - Subitem 2.1<
< - Subitem 2.2<
Ordered Lists
<1. First item<
<2. Second item<
<1. Subitem 2.1<
<2. Subitem 2.2<
Links
<[Youtube](https://youtube.com)<
Images
<<
For the documentation I followed the steps they gave us on the page.
* Gitlab documentation - Gitlab -
Access to GitLab is provided through the Fablabs.io :
-
Find my name
-
To be able to edit it is necessary to "sign in" and only that option is selected. If the "edit" button does not appear green, it is because you have not logged in correctly.
- Customize the page I made some changes like the color change, and added some information
- Changes You can see that a change was made to the git page because a "source control" notification is triggered
To see the changes updated, it is necessary to press the "commit and push" button that allows information to be packaged and updated in the system
You can see the updated changes on the page, For that you need to update the git page. Finally you can see the changes, it is better to do it from an "unknown" page
To insert images
To insert the images it is necessary that the images are first loaded in the images section.
To better organize myself, I make a folder of images for each week of assignments.
When the folder is created, only the images are copied from the source.
Finally, in order to insert the image I use the command: "(../images/)" and select the image I want to place
To insert videos To insert videos you can use:
How to insert a video?
This is the code snippet you can use to embed a video:
<!DOCTYPE html>
<html lang="es">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Mi Video</title>
</head>
<body>
<h1>Video Insertado</h1>
<iframe width="560" height="315"
src="https://www.youtube.com/embed/CÓDIGO_VIDEO"
title="Video de YouTube" frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen>
</iframe>
</body>
</html>
You only need to insert the video link in the section "SRC".
Conclusion¶
Using GitLab offers a powerful, integrated platform for version control. The tutorials offered were very useful, they are very well detailed, clear and easy to follow. I know that it is of great importance to do the documentation.
References & Inspiration¶
I reviewed some pages of students from past generations and I liked these:
- Two images side-by-side
* Gudrita Lape - Gudrita Lape -
* Pauline Gamore - Pauline Gamore -
* Clara Acioli - [Clara Acioli -](https://class.textile-academy.org/2023/clara-acioli/ )