1. State of the art, project management and documentation

This week I worked on defining my final project idea and started to getting used to the documentation process.

Assignment - Build a documentation website describing me and my motivation for the textile-academy, including my previous work √
- Upload the documentation to my project page on class.textile-academy.org √
- Add references and research based on the topic of your interest √
- Learn how to upload images, videos, references and how to use markdown and gitlab √
- EXTRA POINT Customize your website and document how you did it

How will it be evaluated - Learn the process and tools used to document course work √
- Acquire the necessary skills to publish projects, documentation and share the results of each assignment √

Stackedit

Markdownguide

My web Commits (I wish you have acess to this link)

Workflow

  • Research about MarkDown
  • Build a documentation website
  • Modify GitLab repo
  • Clone repo to local computer
  • Push to GitLab repo

Research

It is an interesting editor to learn and write on MarkDown where I have find different examples to appliy and write. Here https://www.markdownguide.org/basic-syntax/ you also will find some relevant information about how to use syntax in MarkDown.

Conclusion:I found this language really easy and fast to documentation. I have also find some errors when you want to display diagrams on Gitlab repo and Fabricademy web page that you will see before on Diagram problem.

Build a documentation website

As you will see here I have been modification my website and I have also clone the repo and push it on-line https://class.textile-academy.org/2020/roberto.gallo/ and https://gitlab.fabcloud.org/academany/fabricademy/2020/students/roberto.gallo/commits/master. As you may see on commits dashboard there are some commites upload by FabLab ZOI those are done bya my computer (local). Also my lab website ZOI https:www.zoi.ec it is using gitlab as host platform. And we are driving our web to static to a dynamic.

Clonning Repo and Upload File

Exploring Code
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.

Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?

Final Diagram Code

This code correspond to a diagram that you can’t see on Fabricademy Display web but if you click to GitLab botton in your left up corner you can open this assignment on GitLab repo and you may see the nice diagram that I learn to code. I am not really happy with the result because esthetics. That is why I will design in a CAD file a super nice diagram and display on final project part.

graph LR
A{Cacao Plantation} --Harvest Beens--> D(Cacao Waste)
D -- AnalizeBio-->H
D -- AnalizeMatter-->H

H(Process)
H--Organism1-->L
H--Organism2-->L
H--NO Organism-->L

L(Bio Material)-- A --> O 
L(Bio Material)-- B --> O
L(Bio Material)-- C --> O

O((BioProduct))
O--Test--> Q(Market)
Q-->R

R(BioProduct Waste)
R-->A
R-->H
Diagram problem

Diagrams are working perfectly on GitLab Display but they are not working well on Fabricademy web.

Embed Sample Video Code

I have been figuring out how to put a MP4 video that is not in Youtube or Vimeo and I have found this piece of code on Stackoverflow

<video width="320" height="240" controls>
<source src="movie.mp4" type="video/mp4">
</video>

And then I just changed the direction, pointing to my webpage and I changed the size of the frame

<video width="800" height="480" controls>
<source src="http://bitsandatomspen.com/videobap.mp4" type="video/mp4">
</video>

And it worked perfectly!