CONTRIBUTING.md

CONTRIBUTING

• CONTRIBUTING
  • Repo map
  • Build locally
    • Prerequisites
      • node.js
      • Hugo
    • Clone repo and its submodules
    • Install javascripts dependencies
    • Serve the website locally

Repo map

├── .github              # for continuous integration and issue / PR templates
│   └── workflows
├── assets               # for javascript and CSS
│   ├── js
│   └── scss
├── content              # where you put the actual content
│   └── en
│       ├── admins       # folders will use layout defined in the "layouts" folder
│       ├── docs         # or in the "themes/docsy/layouts" folders
│       └── tutorials
├── data
├── layouts              # where we put the HTML code of how things are formatted
│   ├── admins
│   ├── blog
│   ├── shortcodes       # can overrule layouts from "themes/docsy/layouts"
│   │   ├── blocks
│   │   └── params
│   └── tutorials
└── themes
    └── docsy            # docsy theme submodule: DO NOT TOUCH
        ├── assets
        ├── .git
        ├── i18n
        ├── images
        ├── layouts
        ├── static
        └── userguide

Build locally

Prerequisites

node.js

A quick version (for Mac and Linux) that will also allow to manage different version of node is to install node via the "node version manager".

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.11/install.sh | bash

open a new terminal or source your .bashrc and then:

nvm install node

Hugo

• See the install page

one example for Linux or for the Windows Sub-system for Linux:

wget https://github.com/gohugoio/hugo/releases/download/v0.92.2/hugo_extended_0.92.2_Linux-64bit.tar.gz
tar xfz hugo_extended_0.92.2_Linux-64bit.tar.gz
echo "export PATH=`pwd`:\$PATH" >> ~/.bashrc
source ~/.bashrc
which hugo

Clone repo and its submodules

git clone --recurse-submodules https://github.com/brainhackorg/brainhack_cloud
cd brainhack_cloud

If you have only cloned the repo and did not get all the submodules (docsy and docsy's own subdmodules), simply run

git submodule update --init --recursive && git submodule update --recursive

Install javascripts dependencies

npm install

Serve the website locally

hugo server -D