Docker based development for Jekyll

.gitignore

@@ -2,6 +2,6 @@ _site
 .sass-cache
 .jekyll-metadata
 .DS_Store
-Gemfile.lock
 .idea
 .jekyll-cache
+.ruby-version

CONTRIBUTING.md

@@ -70,6 +70,23 @@ If you want to make minor changes to an existing file, you can use this approach
 
 If you're adding a new page or making major changes to the documentation, such as adding new images, sections, or styling, we recommend that you work in a local copy of the repository and test the rendered HTML before submitting a PR. 
 
+#### Setting up your Docker based copy of the repository
+This assumes you have Docker installed.
+
+1. [Fork this repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone your fork.
+
+1. Navigate to your cloned repository.
+
+1. Build the documentation website Jekyll image via: `docker build -t documentation-website .`
+
+1. Start Jekyll via: `docker run -p 4000:4000 -v $(pwd):/app documentation-website`
+
+Be aware that it takes a while to build the site the first time, eventually you will see `Server running... press ctrl-c to stop`.
+
+> __Note__: If you would like to run a hosted version of the documentation site you will need to do the following: 
+> 1. Change the URL in `_config_docker.yml` to either your hostname or ip: `url: "http://10.0.0.5:4000"`
+> 1. Change the `HOST` and `JEKYLL_ENV` variables: `docker run -p 4000:4000 -e JEKYLL_ENV=production -e HOST=0.0.0.0 -v $(pwd):/app documentation-website
+
 #### Setting up your local copy of the repository
 
 Follow these steps to set up your local copy of the repository:
@@ -78,11 +95,11 @@ Follow these steps to set up your local copy of the repository:
 
 1. Navigate to your cloned repository.
 
-1. Install [Ruby](https://www.ruby-lang.org/en/) if you don't already have it. We recommend [RVM](https://rvm.io/), but you can use any method you prefer:
+1. Install [Ruby](https://www.ruby-lang.org/en/) version 3.2.4 if you don't already have it. We recommend [RVM](https://rvm.io/), but you can use any method you prefer:
 
    ```
    curl -sSL https://get.rvm.io | bash -s stable
-   rvm install 3.2
+   rvm install 3.2.4
    ruby -v
    ```
 

Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:3.2.4
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock ./
+
+RUN bundle install
+
+# Expose the default Jekyll port
+EXPOSE 4000
+
+# Enable the link checker
+ENV JEKYLL_LINK_CHECKER="internal"
+ENV JEKYLL_ENV=development
+ENV HOST=127.0.0.1
+
+CMD ["bundle", "exec", "jekyll", "serve", "--host", "$HOST", "--port", "4000", "--incremental", "--livereload", "--trace", "--config", "_config.yml,_config_docker.yml"]

Gemfile

@@ -1,5 +1,7 @@
 source "http://rubygems.org"
 
+ruby "3.2.4"
+
 # Hello! This is where you manage which Jekyll version is used to run.
 # When you want to use a different version, change it below, save the
 # file and run `bundle install`. Run Jekyll with `bundle exec`, like so:

Gemfile.lock

@@ -0,0 +1,197 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    bigdecimal (3.1.8)
+    colorator (1.1.0)
+    concurrent-ruby (1.3.1)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    ethon (0.16.0)
+      ffi (>= 1.15.0)
+    eventmachine (1.2.7)
+    ffi (1.16.3)
+    forwardable-extended (2.6.0)
+    google-protobuf (4.27.0)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.27.0-aarch64-linux)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.27.0-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.27.0-x86-linux)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.27.0-x86_64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.27.0-x86_64-linux)
+      bigdecimal
+      rake (>= 13)
+    http_parser.rb (0.8.0)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-last-modified-at (1.3.0)
+      jekyll (>= 3.7, < 5.0)
+      posix-spawn (~> 0.3.9)
+    jekyll-redirect-from (0.16.0)
+      jekyll (>= 3.3, < 5.0)
+    jekyll-remote-theme (0.4.3)
+      addressable (~> 2.0)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
+      rubyzip (>= 1.3.0, < 3.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-sitemap (1.4.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    just-the-docs (0.3.3)
+      jekyll (>= 3.8.5)
+      jekyll-seo-tag (~> 2.0)
+      rake (>= 12.3.1, < 13.1.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.9.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    posix-spawn (0.3.15)
+    public_suffix (5.0.5)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.11.1)
+      ffi (~> 1.0)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
+    rouge (4.2.1)
+    ruby-enum (1.0.0)
+    ruby-link-checker (0.2.0)
+    rubyzip (2.3.2)
+    safe_yaml (1.0.5)
+    sass-embedded (1.77.3)
+      google-protobuf (>= 3.25, < 5.0)
+      rake (>= 13)
+    sass-embedded (1.77.3-aarch64-linux-android)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-aarch64-linux-gnu)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-aarch64-linux-musl)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-aarch64-mingw-ucrt)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-arm-linux-androideabi)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-arm-linux-gnueabihf)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-arm-linux-musleabihf)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-arm64-darwin)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-riscv64-linux-android)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-riscv64-linux-gnu)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-riscv64-linux-musl)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86-cygwin)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86-linux-android)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86-linux-gnu)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86-linux-musl)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86-mingw-ucrt)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86_64-cygwin)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86_64-darwin)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86_64-linux-android)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86_64-linux-gnu)
+      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.77.3-x86_64-linux-musl)
+      google-protobuf (>= 3.25, < 5.0)
+    strscan (3.1.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    typhoeus (1.4.1)
+      ethon (>= 0.9.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  aarch64-linux
+  aarch64-linux-android
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  aarch64-mingw-ucrt
+  arm-linux-androideabi
+  arm-linux-gnueabihf
+  arm-linux-musleabihf
+  arm64-darwin
+  riscv64-linux-android
+  riscv64-linux-gnu
+  riscv64-linux-musl
+  ruby
+  x86-cygwin
+  x86-linux
+  x86-linux-android
+  x86-linux-gnu
+  x86-linux-musl
+  x86-mingw-ucrt
+  x86_64-cygwin
+  x86_64-darwin
+  x86_64-linux
+  x86_64-linux-android
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  jekyll (~> 4.3.2)
+  jekyll-last-modified-at
+  jekyll-redirect-from (~> 0.16)
+  jekyll-remote-theme (~> 0.4)
+  jekyll-sitemap
+  just-the-docs (~> 0.3.3)
+  ruby-enum
+  ruby-link-checker
+  typhoeus
+  tzinfo-data
+  webrick (~> 1.7)
+
+RUBY VERSION
+   ruby 3.2.4p170
+
+BUNDLED WITH
+   2.5.11

_config_docker.yml

@@ -0,0 +1 @@
+url: "http://127.0.0.1:4000"