Skip to content

1. Principles and Practices

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

Aegean Idea Lab on Vimeo

Video Copyright Sodium Burn Creative

How to document

I started my website by editing Markdown directly in GitLab

  1. Log into https://gitlab.fabcloud.org
  2. Browse to files and edit index.md
  3. Hit commit!!
  4. Don’t worry if you have commitment issues, you can always revert to an earlier version
  5. Scaled down the size of images at tinypng then uploaded images in gitlab
  6. Edit week01.md
  7. Update mydocs.yml: file which adjust colors, fonts and links to control the style for your entire document
  8. Repeat process until happy with the result (note this can be an endless loop!)

Things I Learned about Documentation and Markdown

Use the three backticks to separate code.

// HTML Code to create an ordered list
<ol>
  <li>item one</li>
  <li>item two </li>
  <li>item three</li>
</ol>

Assignment 2: Work through a Git tutorial

I started with this tutorial from Victor and Kris in the 2020 Fab Academy cycle.

20200203 Version Control from Academany on Vimeo.

I also used Matthew Hotsko’s tutorial.

I think I am missing a step with adding a gitlab.yml file somewhere in gitlab?

I found this instruction confusing in the video and need to pause and watch again.

I went into the Finder window in my mac and typed Terminal to launch the Terminal

I generated a SSH key pair using the following command in the Terminal

ssh-keygen -t rsa -C “myemail@blahblah.com” -b 4096

The prompt asked for a file name to store the key

Enter file in which to save the key (/Users/katherinesinclair/.ssh/id_rsa): my_sshkey

I then started to set up Git from the Terminal

git config –global user.name “katherine.sinclair”

I get the following notice: xcode-select: note: no developer tools were found at ‘/Applications/Xcode.app’, requesting install. Choose an option in the dialog to download the command line developer tools.

So I need to download XCode tools

Then I type:

git config –global user.email “youremail@blahblah.com”

I get the same error xcode-select: note: no developer tools were found at ‘/Applications/Xcode.app’, requesting install. Choose an option in the dialog to download the command line developer tools.

Even though I downloaded XCode Tools? hm??

I get a “cannot download because of network error” so i tried downloading developer tools again

Then I try to clone my git repository

git clone git@gitlab.fabcloud.org:academany/fabacademy/2021/labs/incitefocus/local.git

I get the following error again: note: no developer tools were found at ‘/Applications/Xcode.app’, requesting install. Choose an option in the dialog to download the command line developer tools.

I then continue the tutorial although it is clear that soemthing is wrong.

I change my directory which is (cd- for change directory) Note the ~/ takes you back a level in the file system

cd ~/Desktop

The clone did not work as my repository is not on my Desktop!

I then type ls (which lists the contents of your directory) pwd- prints working directory- a useful command so you know where you are

ls pwd cd fabacademy cd week1

I created a simple README file in my week1 folder with emacs

I used Matthew’s tutrorial and tested uploading the README file to my repository

Katherines-MacBook-Pro:week1 katherinesinclair$ git add README

I got the following fatal error: fatal: not a git repository (or any of the parent directories): .git

Katherines-MacBook-Pro:week1 katherinesinclair$ git commit -m “add README”

I got the following fatal error: fatal: not a git repository (or any of the parent directories): .git

Katherines-MacBook-Pro:week1 katherinesinclair$ git push -u origin master

I got the following fatal error: fatal: not a git repository (or any of the parent directories): .git

Hm. So this was an epic fail. Back to the beginning!

Last update: February 3, 2021