Docker Environment Setup

Prerequisites

The preferred way to develop contributions for this repository is to develop from inside Docker. This ensures that the changes are tested under the exact same environment by every contributor, regardless of your host OS.

To be able to use the environment recommended by this repository you'll need to install Docker and Visual Studio Code as well as the Remote - Containers extension for VS Code.

> docker -v
Docker version 19.03.12

> code -v
1.47.3

Setup

Once you have installed all the dependencies, open VS Code, go to the bottom left corner of the IDE and click on the new Status Bar item. From the drop-down menu choose Remote - Containers: Open Folder in Container... and then select the root directory of this repository. This will initiate the one time setup of the environment inside an isolated container.

The installation of dependencies should be performed before VS Code returns control to the user. The install command is located in .devcontainer/devcontainer.json, under the "postCreateCommand" key.

Debug

Once you have completed the steps above, you can run the documentation website locally, by executing the following command.

> bundle exec jekyll serve

This will start a local server which will serve the documentation on http://127.0.0.1:4000 which will be forwarded to the same address on your host environment.