From 080962cfa12b191b20f40bcb7bf3e7fab1ad50fd Mon Sep 17 00:00:00 2001 From: Shay Nehmad Date: Wed, 2 Sep 2020 22:24:47 +0300 Subject: [PATCH] Added documentation which explains how to use swimm --- docs/content/development/swimm.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 docs/content/development/swimm.md diff --git a/docs/content/development/swimm.md b/docs/content/development/swimm.md new file mode 100644 index 000000000..9ab29e40b --- /dev/null +++ b/docs/content/development/swimm.md @@ -0,0 +1,29 @@ +--- +title: "Swimm tutorials" +date: 2020-09-02T22:14:58+03:00 +draft: false +weight: 3 +tags: ["contribute"] +--- + +The Monkey has development tutorials that use [`swimm.io`](https://swimm.io/) to help teach new developers how to perform common code tasks in the Monkey codebase and help the ramp-up process. The tutorial include adding new configuration values, new system info collectors, and more. + + ![swimm logo](https://swimm.io/img/squarelogo.png "swimm logo") + +# How to start learning + +First, [sign up for swimm's beta](https://swimm.io/sign-beta). `swimm` is free for open-source projects, but as they're still in beta, you need to sign up in order to download it. + +After you've downloaded and installed `swimm`, open a shell in the Monkey repo folder and run: + +```shell script +swimm start +``` + +A local web server with the currently available tutorials should show up, and look something like this: + +![swimm server](https://i.imgur.com/NFBH4Vr.png "swimm server") + +Choose which playlist you'd like to learn, click on it, and follow the instructions. + +🏊‍♀️🏊‍♂️