2. Project Management

Assignment

Build a personal site describing you and your final project.

  • [x] Upload it to the class archive.
  • [x] Work through a git tutorial.

Have you?

  • [x] Made a website and described how you did it
  • [x] Introduced yourself
  • [x] Documented steps for uploading files to archive
  • [x] Pushed to the class archive
  • [x] Signed and uploaded Student Agreement \

Building the personal Website

For my personal Fab Academy experience website i decided to go with the provided MKDocs MarkDown based website simply because the whole course structure is already embedded in there. Also it allows for both online (in a webbrowser) and offline editing so one could use whatever is more convenient per situation.

I find uploading images to the repository a tedious process so i will add those via GIT but the online editing of MarkDown docs is simpler and faster for quick updates.

On another note i use Google Docs as a scratchpad for my random ideas and initial notes. To convert this into MarkDown is yet another tedious process. For this i found a Google Docs plugin that converts directly to MarkDown if you use proper styling.

See below the detailed instructions on updating via GIT

Git setup & workflow

Git is the main tool for project management at FabAcademy. The information sharing, structuring of documents, version management and the evaluation workflows collide through your student GIT repository.

The GIT issue system can be used to get community inputs on bigger issues or just discussions on specific topics.

For this week we work through a Git Tutorial as basis for building the personal student website. This tutorial helped me get it up and running https://www.youtube.com/watch?v=BSjCyKDbWus

For the Fab Academy i use a Mac computer so all instructions are targeted to OSX

Instaling GIT

Setup GIT

  • Open command console and setup your global Git config (since i already had GIT running i skipped this part)

  • Generate the RSA key from your console \

    $ssh-keygen -t rsa -b 2048

    Your identification has been saved in /Users/theoboomsma/.ssh/id_rsa. Your public key has been saved in /Users/theoboomsma/.ssh/id_rsa.pub. The key fingerprint is: ae:89:72:0b:85:da:5a:f4:7c:1f:c2:43:fd:c6:44:38 thboomsa@gmail.com The key's randomart image is: +--[ RSA 2048]----+ | | | . | | E . | | . . o | | o . . S . | | o + . . + | |. + o = o + | | o...o * o | |. o..o . | +-----------------+

  • Setup your global information for communication with the server

    $git config –global user.email thboomsma@gmail.com

    $git config –global user.name “theodorus.boomsma”

    Also change the default git editor from hell VIM to Nano instead

    $git config –global core.editor “nano”

Setup encryption keys for communication with Fab Gitlab server \ Copy your public key to your clipboard

$pbcopy < ~/.ssh/id_rsa.pub

Go to your FabAcademy Repository > User Settings / SSH Keys and paste Key from your clipboard

alt_text

Using GIT

  • Make a copy of your Student Website template to your local drive

    $git clone git@gitlab.fabcloud.org:academany/fabacademy/2019/labs/lakazlab/students/theodorus-boomsma.git \

alt_text

  • Edit the Website template main information

All base information about your website is stored in the file mkdocs.yml so open in an editor and change to your information. Any updates will be automatically picked up by the rendering engine.

alt_text \

Upload changes via GIT command line

#display the updates performed locally \
$git status

#Add all updates to git staging
$git add -A


# Commit the changes locally
$ git commit -m "first updates"

# Sync information between the local and  remote repositories
$Git push


**  **

alt_text

** \

You are done!**