Hammertime Kassel

Setting up the Site Locally

1. Clone the repository from GitHub (e.g. using Sourcetree

2. Download and install Docker

3. In the Docker settings, share the drive with the cloned repository on it

4. Open shell (PowerShell on Windows)

5. Change directory to the cloned repositry from step 1.:

   cd <path_to_your_folder>

   (Replace <path_to_your_folder> with the actual path)

6. Start the Docker container and Jekyll by running:

   docker run --name htks_serve -it --rm --volume=${PWD}:/srv/jekyll --volume=jekyllbundlecache:/usr/local/bundle -p 4000:4000 jekyll/jekyll jekyll serve --watch --incremental

7. Open http://localhost:4000 in your browser. The site will be regenerated if changes are made to the files within the repository. This may take a few seconds.

Workflow for Adding Specific Site Contents

Maintenance of Equipment

The workshop's available or planned equipment is displayed on the equipment page and its subordinated pages. The data for this sites is stored within the _data/areas folder.

Areas

Each subfolder of the _data/areas folder represents a specific area of the workshop, e.g. the sewing area or the Fab lab area. The info.yml within each folder provides informations about the area.

Add a New Area

To create a new area, create a new subfolder within the _data/areas folder. The folder's name must be lowercase and words must be separated by underscores, e.g. wood_workshop and is now called the area_id.

Place an info.yml file within the folder and add the following informations:

name: "" # the full name of the area
short_description: "" # a short description of the area in a few words
description: "" # a more lengthy description of the area

Equipment

Each subfolder of an area folder represents a specific part of our equipment, e.g. a tool or machine. The info.yml within each folder provides informations.

Add a New Service

To create a new service, create a new subfolder within the equipment folder in the _data/areas folder. If there is no fitting area folder, you need to create a new one (see above). The folder's name must be lowercase and words must be separated by underscores, e.g. secabo_ts7_swing_away_heat_press and is now called the equipment_id. The equipment_id needs to be unique. Hint: Use the tool's or device's model number.

Place an info.yml file within the folder and add the following informations:

type: "" # the general type of the equipment, e.g. "3D-Printer"
disable_profile_page: false # set `true` to disable the equipment's profile page, e.g. if there is no profile page available yet or important informations are missing
producer: "" # name of the producer
producer_link: "" # (optional) link to producer's website
model: "" # name of the model
model_link: "" # (optional) link to the model's page on the producer's website
equipment: # list of additional equipment that comes with the tool or machine. List of "name" and "value" pairs.
  -
    name: ""
    value: ""
  -
    name: ""
    value: ""
short_description: "" # short description of the machine or tool in a few words
description: "" # a more lengthy description of the tool or machine
technical_data: # list of technical informations. List of "name" and "value" pairs.
  -
    name: ""
    value: ""
  -
    name: ""
    value: ""
status: "" # possible values: "planned" => equipment is not available yet; "okay" => equipment is available and functional; "limited" => equipment is available but limited in functionality; "broken" => equipment is broken and cannot be used; "repairing" => the equipment is being repaired and cannot be used
additional_status_text: "" # (optional) an additional note that will be displayed beneath the status
images: # (optional) list of images of the equipment. images needs to be placed in the `/images/areas/<area_id>/<equipment_id>/` folder
  - original: "" # original, bigger image. needs to be placed in the `/images/areas/<area_id>/<equipment_id>/original` folder
    small: "" # smaller preview image. needs to be placed in the `/images/areas/<area_id>/<equipment_id>/small` folder
    title: "" # (optional) description for the picture
  - original: ""
    small: ""
    title: ""

After this, the equipment needs its own page. To do that, create a file called <equipment_id>.html within the /ausstattung/ folder. Insert the area_id and equipment_id as follows:

---
area_id: "" # the area_id
equipment_id: "" # the equipment_id
---