1. State of the art, project management and documentation
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 a somewhat familiar with some of the tools used like a bit of github, markdown, terminal, and other tools for version control like Mercurial. So that helped but haven't used them all together in this way. So I had some fun customizing and browsing around.
Research
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! I've decided on a way to organize my files and am looking forward to building this documentation in the next few months. Documenting is something I like doing, because it helps me keep the new skills and insights I've gained fresh and actually usable. As in: being able to redo things I did in the past. That said, I can get a bit wordy doing it, trying to get all the details in, but it's coming from a good place ;)
"Consider the possibility of an honest mess" - Co-Star astrology app
Useful links
- Fiore's tutorial
- This tutorial on the class page (especially how to edit the mkdoc :)
- Getting started with mkdoc.yml file
Setting up the SSH key
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 and popped it into the settings in Gitlab, using this tutorial for [generating an SSH key] (https://gitlab.fabcloud.org/help/ssh/README#generating-a-new-ssh-key-pair)
Also Fiore's tutorial has been very helpful here:
* 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.
OR: push via http and access tokens
Later on I started using my Github Desktop app for a bunch of other stuff and my connection stopped working. I couldn't figure it out so I deleted the repository and cloned it anew over http. This tutorial by Shedrack Akintayo explains how to use access tokens push without having to re-enter your password when pushing over http. Amazeballs, thank you Shedrack!
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
Teal is my favourite color so, I used that for now, I found the name of the color codes here: Squidfunk's tutorial
* I have to say again: I'm really liking markdown and Gitlab
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.