Add a docker container for easier local dev

Author: RealOrangeOne

.dockerignore

@@ -0,0 +1,5 @@
+/gems
+_site
+.sass-cache
+.jekyll-metadata
+.bundle

.github/workflows/validate.yml

@@ -25,3 +25,14 @@ jobs:
 
     - name: Build & Validate
       run: rake validate
+
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Build container
+      run: docker-compose build
+
+    - name: Build site in container
+      run: docker-compose run docs rake build

Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:2.7
+
+ENV GLOBAL_GEMS=true
+
+WORKDIR /usr/src/docs
+
+RUN gem install 'bundler:~>1' rake
+
+COPY . ./
+
+RUN rake dependencies
+
+CMD ["rake", "dev"]

README.md

@@ -4,6 +4,12 @@ The Student Robotics public documentation.
 
 ## Getting Started
 
+For ease of setup, a Docker container is provided. Simply install Docker and `docker-compose`, and run `docker-compose up`.
+
+Once setup, the site will be accessible on http://localhost:4000/docs/
+
+### Manual
+
 1. [Install Ruby][install-ruby]
 
 2. Install Bundler (1.x) and Rake

Rakefile

@@ -9,7 +9,11 @@ task :deep_clean => [:clean] do
 end
 
 task :dependencies do
-  sh('bundle install --path gems')
+  if ENV["GLOBAL_GEMS"]
+    sh('bundle install')
+  else
+    sh('bundle install --path gems')
+  end
 end
 
 file '_sass/brand/.git' do
@@ -19,7 +23,7 @@ end
 task :submodules => ['_sass/brand/.git']
 
 task :dev => [:dependencies, :submodules] do
-  sh('bundle exec jekyll serve --drafts --config _config.yml')
+  sh('bundle exec jekyll serve --host 0.0.0.0 --drafts --config _config.yml')
 end
 
 task :build => [:dependencies, :submodules] do

_config.yml

@@ -56,6 +56,7 @@ exclude:
   - Gemfile.lock
   - gems/
   - Dockerfile
+  - docker-compose.yml
   - _env/
   - _docs/
   - vendor/

docker-compose.yml

@@ -0,0 +1,10 @@
+version: "2.3"
+
+services:
+  docs:
+    build:
+      context: .
+    volumes:
+      - ".:/usr/src/docs"
+    ports:
+      - "4000:4000"