1. State of the art, project management and documentation¶

First week was about using Gitlab and Markdown for the first time to build a personal website for documentation and even more in the future . at first it was overwhelming so i tried to follow the textile academy tutorials for Markdown , look for the documentation for Alumni from previous cohorts it helped me got an over view idea of the websites and Markdown , here some people i like their documentation for this week:

1- Haneen Jafrah

2- Olivia Cueva

3- Dima Hejap

After seeing how people are doing their websites and style it i started to make mood board for the way I want to style my website and I decided to keep it minimalist with white background and keep refresh it as I go to .

What is Gitlab ¶

It is a web based platform works via code,well used for documentation as it provides Git repository to use and be your website or organization website. Read More

Git is a version control system used to track changes in computer files.it is helpful even when you work online to push your documentation to offline and the opposite as it tracks the work and part of its work play administrative tasks.

What is Markdown ¶

It is well used for documentation following the syntax, as it can work with html and CSS while writing the syntax. it is an easy way to code with your documentation and if you are interested to read more about it and how started feel free to Click here

What is Visual Studio ¶

Developed by Microsoft to develop computer programs and build websites. What makes it famous in programming industry is the amount of language support, that makes it practical to be used in many industries. and one of them is documentation here code with Markdown and html and CSS, it is well used if you decide to work offline as you will see the interface in the next sections. Read more

First worked (online) on the Gitlab¶

First time I worked on to write the code i read some notes written and examples on the IDE and that was really helpful and helped me to adjust and to learn how to upload photo , adjust text , headlines and add links , ( I advise you to read what is written on your IDE before delete as some paragraphs might be really time saver! )

Access to Fabricademy Participants Markdown code¶

Here are a few things I like while working is the access to your own Code and all Fabricademy participants over the years.

Whenever you find any documentation or layout that seems interesting to you can enter the participant documentation and have a look! Here is a photo shows you where to click as you can click on Code then web IDE and the code will be previewed.

Online Interface

Referances¶

Some references and markdown cheat sheet were helpful when writing a code and you can even copy paste and adjust it based on your data. here are some helpful links: Sheet1 , Sheet2

Second Offline Method on Desktop¶

Then I switched to offline mode and honestly, I liked it. It felt great and practical to write my notes, organize my thoughts, and draft everything week by week before publishing. Now, I will walk you step by step through the offline workflow I am using right now as I write this. But here’s my honest advice to you, especially if you never code: start online for the first week. Get familiar with the folders and markdown structure first then move offline once you’re comfortable and can work worry free.

OFFline Setup¶

First Download visual studio and Git to transfer the data from online to the desktop file .¶

You Can download from here : 1. Visual Studio 2. Git

Second Clone your Gitlab from online to offline by Copying your URL¶

Create a new folder on desktop to clone the files too. and I named it textile academy. then go to your Gitlab on web. As mentioned in the previous section where you can find the code, on this image you can find your URL to copy.

After that just type on your search on desktop git and open " like a prompt run " as shown on the photo. However, the first line is the copy of your offline file " the new file made on desktop for textile" then enter >> then make sure to write GitPull then paste the URL link.

Keep in mind that there are other commands such as Git status when you write it on the prompt run of your file can check for you if there is any change happened online and not cloned yet to offline. Let's say it happened in future, and you worked online and forgot to clone to offline mode: you can write after git status output " Git

Have you done above steps? Congratulations now your online GitLab has been cloned to your desktop.¶¶

and Would like to mention that uploading photos for each week assignment was a game change for me and help keep work organized , all inspiration same file and easier access to the photos while upload.

Now you can can write on the Visual Studio . Welcome to the Hub!!

Remember! Always make "Commit & Sync" if you want your offline work to be pushed on your online IDE.

Hope this Documentation could be helpful for you ... even if you feel overwhelmed it is ok. focus on one step, one line and the path will open.