Merge pull request #12 from bzz/documentation

doc: initial pass over participants instructions

Author: bzz

README.md

@@ -24,23 +24,28 @@ Workshop given at [DevFest Nantes 2019](https://devfest.gdgnantes.com/sessions/u
 
 </details>
 
-## Setup
+Slides: on [gDrive](https://docs.google.com/presentation/d/1vF0JMagmXXzn-h-OaJu6CsDt78oSQSg58YFJsBUaHxk/edit#slide=id.g4f0d75b8b4_0_0)
 
-### With make
+OSS tools covered:
+ - [gitbase](https://docs.sourced.tech/gitbase)
+ - [bblfsh](https://doc.bblf.sh)
+ - [BigARTM](http://bigartm.org)
+ - [OpenNMT](http://opennmt.net)
 
-To build the workshop image and launch the 3 required containers
+## Prerequisites
+- Docker
 
-```shell
-make build-and-run
-```
+## Dependencies
 
-To only launch the 3 required containers
+Import Docker images (works offline):
 
-```shell
-make
 ```
+docker load -i images/jupyter.tgz
+docker load -i images/gitbase.tgz
+docker load -i images/bblfshd-with-drivers.tgz
 
-### Without make
+docker images
+```
 
 Run bblfsh
 
@@ -66,16 +71,10 @@ docker run \
     --link devfest_bblfshd:devfest_bblfshd \
     --env BBLFSH_ENDPOINT=devfest_bblfshd:9432 \
     --env MAX_MEMORY=1024 \
-    --volume /home/mog/work/devfest2019-workshop/repos:/opt/repos \
+    --volume $(pwd)/repos:/opt/repos \
     srcd/gitbase:v0.24.0-rc2
 ```
 
-Build the jupyter image
-
-```shell
-docker build -t devfest .
-```
-
 Run the jupyter image
 
 ```shell
@@ -85,7 +84,46 @@ docker run \
     --publish 8888:8888 \
     --link devfest_bblfshd:devfest_bblfshd \
     --link devfest_gitbase:devfest_gitbase \
-    --volume /home/mog/work/devfest2019-workshop/notebooks:/devfest/notebooks \
-    --volume /home/mog/work/devfest2019-workshop/repos:/devfest/repos \
+    --volume $(pwd)/notebooks:/devfest/notebooks \
+    --volume $(pwd)/repos:/devfest/repos \
     devfest
 ```
+
+<details>
+<summary>With make</summary>
+
+To build the workshop image and launch the 3 required containers
+
+```shell
+make build-and-run
+```
+
+To only launch the 3 required containers
+
+```shell
+make
+```
+</details>
+
+
+## Workflow
+
+### 1. Download the data
+
+We are going to use top XXX repositories from Apache Software Foundation though this workshop.
+
+[Notebook 1: data collection pipeline](#link to local jupyther)
+
+### 2. Project and Developer Similarities
+
+TBD
+
+[Notebook 2: project and developer similarities](#link to local jupyther)
+
+
+### 3. Function Name Suggestion
+
+TBD
+
+[Notebook 2: function name suggestion](#link to local jupyther)
+

images/README.md

@@ -0,0 +1,25 @@
+Images, created for workshop to be used offline.
+
+# bblfshd + drivers image
+
+```
+docker pull bblfsh/bblfshd:v2.15.0-drivers
+docker save -o images/bblfshd-with-drivers.tgz bblfsh/bblfshd:v2.15.0-drivers
+```
+
+
+# gitbase image
+
+```
+docker pull srcd/gitbase:v0.24.0-rc2
+docker save -o images/engine.tgz srcd/gitbase:v0.24.0-rc2
+```
+
+# jupyter image
+
+Build the jupyter image:
+
+```shell
+docker build -t devfest .
+docker save -o images/jupyter.tgz devfest
+```