Jekyll containerisation (#17)

* Jekyll containerisation
* docker-compose conf
* Update docker-compose.yaml
* adding more detailed instructions to README,

and we are still needing to debug an issue with bringing up the latest
jekyll container (4.0.0) that seems to have a permissions error to
write to /usr/gem/cache that does not exist in the container

Signed-off-by: vsoch <[email protected]>

* updating jekyll/jekyll to use 3.8 as 4.0 has permissions error bug
Signed-off-by: vsoch <[email protected]>

Co-authored-by: Jinna Balu <[email protected]>
Co-authored-by: vsoch <[email protected]>

Author: 3 people

Diff for: README.md

@@ -52,3 +52,47 @@ jekyll serve
 # or
 bundle exec jekyll serve
 ```
+
+### 5. Run as a container in dev or prod
+
+#### Software Dependencies
+
+If you want to run docsy jekyll via a container for development (dev) or production (prod) you can use containers. This approach requires installing [docker-ce](https://docs.docker.com/engine/install/ubuntu/) and [docker-compose](https://docs.docker.com/compose/install/). 
+
+#### Customization
+
+Note that the [docker-compose.yml](docker-compose.yml) file is using the [jekyll/jekyll:3.8](https://hub.docker.com/r/jekyll/jekyll/tags) image. If you want to make your build more reproducible, you can specify a particular version for jekyll (tag). Note that at the development time of writing this documentation, the latest was tag 4.0.0,
+and it [had a bug](https://github.com/fastai/fastpages/issues/267#issuecomment-620612896) that prevented the server from deploying.
+
+If you are deploying a container to production, you should remove the line to
+mount the bundles directory to the host in the docker-compose.yml. Change:
+
+```yaml
+    volumes: 
+      - "./:/srv/jekyll"
+      - "./vendor/bundle:/usr/local/bundle"
+      # remove "./vendor/bundle:/usr/local/bundle" volume when deploying in production
+```
+
+to:
+
+```yaml
+    volumes: 
+      - "./:/srv/jekyll"
+```
+
+This additional volume is optimal for development so you can cache the bundle dependencies,
+but should be removed for production. 
+
+#### Start Container
+
+Once your docker-compose to download the base container and bring up the server:
+
+```bash
+docker-compose up -d
+```
+
+You can then open your browser to [http://localhost:4000](http://localhost:4000)
+to see the server running.
+
+> Node : changes `baseurl: ""` in _config.yml  when you are running in local and prod according to the requirement.

Diff for: docker-compose.yaml

@@ -0,0 +1,12 @@
+version: '3.7'
+services:
+  site:
+    container_name: docsy
+    command: jekyll serve --watch --drafts
+    image: jekyll/jekyll:3.8
+    volumes: 
+      - "./:/srv/jekyll"
+      - "./vendor/bundle:/usr/local/bundle"
+      # remove "./vendor/bundle:/usr/local/bundle" volume when deploying in production
+    ports: 
+      - "4000:4000"