Skip to content
Snippets Groups Projects
Commit b8d2d213 authored by Loes's avatar Loes
Browse files

update wk 1 notes on setting up the basics week01.md

parent 151c6506
No related branches found
No related tags found
No related merge requests found
# 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.
This week I didn't really work on defining my final project idea. I've been sick for a few days, so just tried to keep up by doing the assignment for the week and building the documentation structure...
I'm pretty familiar with some of the tools used like version control, markdown, terminal etc. So that helped but haven't used them all together in this way. So I had some fun customizing and browsing around.
## Research
"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
This week's research mainly consisted of learning these tools using the tutorials provided and some google. It was nice, I'm liking this way of documenting!
> "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."
> "Inspirational block quote here! I'll have to get back to you on that one, but nice to know how to do it - LB"
## Useful links
- [Jekyll](http://jekyll.org)
- [Google](http://google.com)
- [Markdown](https://en.wikipedia.org/wiki/Markdown)
- [Fiore's tutorial](https://vimeo.com/253336757)
- [This tutorial on the class page (especially how to edit the mkdoc :)](https://class.textile-academy.org/tools/tutorials/gitlab/)
- [Getting started with mkdoc.yml file](https://squidfunk.github.io/mkdocs-material/getting-started/#font-family)
## Setting up the SSH key
## Code Example
Tried to rush it and left the default email in by accident. Whoops!
Deleted the key and generated a new one with the terminal commands provided here and popped it into the settings in Gitlab
[Generating an SSH key] (https://gitlab.fabcloud.org/help/ssh/README#generating-a-new-ssh-key-pair)
Use the three backticks to separate code.
Also Fiore's tutorial has been very helpful here:
- [Fiore's tutorial](https://vimeo.com/253336757)
```
// the setup function runs once when you press reset or power the board
void setup() {
// initialize digital pin LED_BUILTIN as an output.
pinMode(LED_BUILTIN, OUTPUT);
}
// the loop function runs over and over again forever
void loop() {
digitalWrite(LED_BUILTIN, HIGH); // turn the LED on (HIGH is the voltage level)
delay(1000); // wait for a second
digitalWrite(LED_BUILTIN, LOW); // turn the LED off by making the voltage LOW
delay(1000); // wait for a second
}
```
\* *I notice I'm becoming one of those people who writes documentation but doesn't explain the steps that already feel "normal" to me. Hmmm. I'll have a think to think what I think about that.
## Customizing text, fonts, colors in the mkdoc
I customized some basic stuff to change the look of the page. I love the font Karla, we use it for everything where I work, so I'm using it here too. I think you can basically look up any Google Font and use it. I liked the idea of having a special font for code, so I specified one for that as well.
[Find a Google Font here](https://fonts.google.com/?query=karla)
## Gallery
Teal is my favourite color so, I used that for now, I found the name of the color codes here:
[Squidfunk's tutorial](https://squidfunk.github.io/mkdocs-material/getting-started/#color-palette)
![](../images/sample-photo.jpg)
\* *I have to say again: I'm really liking markdown and Gitlab*
## Video
Ah yes! I will make a favicon but not right now, so just put the line there and will uncomment it once I've created and uploaded one.
### From Vimeo
```
# This is some of the code I changed in the mkdoc :)
site_name: Loes Bogers
site_description: Loes' Fabricademy documentation
site_url: https://class.textile-academy.org/2020/loes.bogers/
repo_url: https://gitlab.fabcloud.org/academany/fabricademy/2020/students/loes.bogers
site_author: Loes Bogers
docs_dir: docs
site_dir: _site
copyright: Copyright 2019 Loes Bogers - Creactive Commons Attribution Non-commercial
theme:
#uncomment line below when you made a favicon lollll
# favicon: 'assets/images/favicon.ico'
name: material
font:
text: 'karla'
code: 'ubuntu mono'
# try other colors https://squidfunk.github.io/mkdocs-material/getting-started/#primary-colors
palette:
primary: "cyan"
accent: "purple"
```
<iframe src="https://player.vimeo.com/video/10048961" width="640" height="480" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen></iframe>
<p><a href="https://vimeo.com/10048961">Sound Waves</a> from <a href="https://vimeo.com/radarboy">George Gally (Radarboy)</a> on <a href="https://vimeo.com">Vimeo</a>.</p>
## Working offline
### From Youtube
Since I'm working on a book project where I'll be using some of these tools as well, I also tried cloning my repository into the GitHub Desktop app using the URL provided in the back-end of the project using the SSH dropdown.
# ![](../images/sample-photo.jpg)
*image will follow*
<iframe width="560" height="315" src="https://www.youtube.com/embed/jjNgJFemlC4" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
It's pretty straightforward, you go find the files locally and them edit them with an editor. I'm used to Brackets from back when I did Fabacademy. [Oh sweet memories from 2015](https://fabacademy.org/archives/2015/eu/students/bogers.loes/finalproject.html)
## 3D Models
But for another project I'll be using MacDown, which gives a nice simultaneous preview! Pretty nice too. Let's see which one I'll end up using.
# ![](../images/sample-photo.jpg)
*image will follow*
<div class="sketchfab-embed-wrapper"><iframe width="640" height="480" src="https://sketchfab.com/models/658c8f8a2f3042c3ad7bdedd83f1c915/embed" frameborder="0" allow="autoplay; fullscreen; vr" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
## Updating the info on the index page
<p style="font-size: 13px; font-weight: normal; margin: 5px; color: #4A4A4A;">
<a href="https://sketchfab.com/models/658c8f8a2f3042c3ad7bdedd83f1c915?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Dita&#39;s Gown</a>
by <a href="https://sketchfab.com/francisbitontistudio?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Francis Bitonti Studio</a>
on <a href="https://sketchfab.com?utm_medium=embed&utm_source=website&utm_campaign=share-popup" target="_blank" style="font-weight: bold; color: #1CAAD9;">Sketchfab</a>
</p>
</div>
\ No newline at end of file
Coming soon
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment