Dependency Upgrade & New Theme Integration

.buildkite/build.pipeline.yml

@@ -0,0 +1,18 @@
+steps:
+  - label: "Build & Push Staging Docker Image"
+    commands:
+      - echo $$REGISTRY_PASSWORD | docker login adabay.azurecr.io --username $$REGISTRY_USERNAME --password-stdin
+      - docker run --rm -v "$$PWD":/usr/src/app -w /usr/src/app ruby:3.2.2 bash -c "bundle config set --local path '/usr/src/app/vendor' && bundle install"
+      - docker run --rm -v "$$PWD":/usr/src/app -w /usr/src/app ruby:3.2.2 bash -c "bundle config set --local path '/usr/src/app/vendor' && bundle exec jekyll build"
+      - docker build --pull --progress plain -f Staging.Dockerfile -t adabay.azurecr.io/fz-juelich/website/parallel-in-time:latest .
+      - docker push adabay.azurecr.io/fz-juelich/website/parallel-in-time:latest
+      - docker logout adabay.azurecr.io
+    plugins:
+      - adabay/vault-key-value#v0.9.5:
+          secrets:
+            - secret_path: "static/ci/username-password-combinations/adabay.azurecr.io"
+              secret_key: "username"
+              exported_env_variable_name: "REGISTRY_USERNAME"
+            - secret_path: "static/ci/username-password-combinations/adabay.azurecr.io"
+              secret_key: "password"
+              exported_env_variable_name: "REGISTRY_PASSWORD"

.github/workflows/publish.yml

@@ -18,7 +18,7 @@ jobs:
       - name: 💎 setup ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 2.4.1 # can change this to 2.7 or whatever version you prefer
+          ruby-version: 3.2.2
           bundler-cache: true
 
       - name: 🔨 install dependencies & build site

.gitignore

@@ -79,3 +79,4 @@ Temporary Items
 
 ### IDEs ###
 .idea/
+.vscode/

Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org/'
-ruby '2.4.1'
+ruby '3.2.2'
 
 # other dependencies
 gem 'sass'
@@ -8,16 +8,16 @@ gem 'coffee-script'
 gem 'autoprefixer-rails'
 gem 'mini_magick'
 
-gem 'jekyll', '>=3.0'
+gem 'jekyll', '>=4.2'
 
 # Jekyll Plugins
 gem 'jekyll-watch'
 gem 'jekyll-paginate'
 gem 'jekyll-feed'
-gem 'jekyll-assets'
 gem 'jekyll-sitemap'
 gem 'jekyll-scholar'
+gem 'liquid-tag-parser'
+gem 'bulma-clean-theme'
 # gem 'jekyll-archives'
 
 gem 'jgd'
-gem 'therubyracer'

Gemfile.lock

@@ -1,134 +1,147 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.1)
+    addressable (2.8.5)
       public_suffix (>= 2.0.2, < 6.0)
-    autoprefixer-rails (8.6.3)
-      execjs
-    bibtex-ruby (4.4.7)
+    autoprefixer-rails (10.4.13.0)
+      execjs (~> 2)
+    bibtex-ruby (6.0.0)
       latex-decode (~> 0.0)
-    citeproc (1.0.9)
+    bulma-clean-theme (0.13.3)
+      jekyll (>= 3.9, < 5.0)
+      jekyll-feed (~> 0.15)
+      jekyll-paginate (~> 1.1)
+      jekyll-seo-tag (~> 2.7)
+      jekyll-sitemap (~> 1.4)
+      kramdown-parser-gfm (~> 1.1)
+    citeproc (1.0.10)
       namae (~> 1.0)
-    citeproc-ruby (1.1.10)
+    citeproc-ruby (1.1.14)
       citeproc (~> 1.0, >= 1.0.9)
-      csl (~> 1.5)
+      csl (~> 1.6)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
-    coffee-script-source (1.10.0)
+    coffee-script-source (1.12.2)
     colorator (1.1.0)
-    concurrent-ruby (1.1.5)
-    csl (1.5.0)
+    concurrent-ruby (1.2.2)
+    csl (1.6.0)
       namae (~> 1.0)
-    csl-styles (1.0.1.8)
+      rexml
+    csl-styles (1.0.1.11)
       csl (~> 1.0)
-    em-websocket (0.5.1)
+    em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
-      http_parser.rb (~> 0.6.0)
+      http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    execjs (2.7.0)
+    execjs (2.8.1)
     extras (0.3.0)
       forwardable-extended (~> 2.5)
-    fastimage (2.1.3)
-    ffi (1.11.1)
+    ffi (1.15.5)
     forwardable-extended (2.6.0)
-    http_parser.rb (0.6.0)
-    i18n (0.9.5)
+    google-protobuf (3.24.0-aarch64-linux)
+    google-protobuf (3.24.0-x86_64-linux)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.4)
+    jekyll (4.3.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
-      i18n (~> 0.7)
-      jekyll-sass-converter (~> 1.0)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
       jekyll-watch (~> 2.0)
-      kramdown (~> 1.14)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
       liquid (~> 4.0)
-      mercenary (~> 0.3.3)
+      mercenary (>= 0.3.6, < 0.5)
       pathutil (~> 0.9)
-      rouge (>= 1.7, < 4)
+      rouge (>= 3.0, < 5.0)
       safe_yaml (~> 1.0)
-    jekyll-assets (2.4.0)
-      concurrent-ruby (~> 1.0)
-      extras (~> 0.2)
-      fastimage (~> 2.0, >= 1.8)
-      jekyll (~> 3.1, >= 3.0)
-      pathutil (>= 0.8)
-      rack (~> 1.6)
-      sprockets (~> 3.3, < 3.8)
-    jekyll-feed (0.4.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
     jekyll-paginate (1.1.0)
-    jekyll-sass-converter (1.5.2)
-      sass (~> 3.4)
-    jekyll-scholar (5.13.0)
-      bibtex-ruby (~> 4.0, >= 4.0.13)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-scholar (7.1.3)
+      bibtex-ruby (~> 6.0)
       citeproc-ruby (~> 1.0)
       csl-styles (~> 1.0)
-      jekyll (~> 3.0)
-    jekyll-sitemap (0.10.0)
-    jekyll-watch (2.0.0)
+      jekyll (~> 4.0)
+    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)
-    jgd (1.7.1)
+    jgd (1.13.0)
       jekyll (>= 1.5.1)
-      trollop (= 2.1.2)
-    json (2.3.1)
-    kramdown (1.17.0)
-    latex-decode (0.3.1)
-    libv8 (3.16.14.19)
-    liquid (4.0.3)
-    listen (3.2.0)
+      trollop (= 2.9.9)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    latex-decode (0.4.0)
+    liquid (4.0.4)
+    liquid-tag-parser (2.0.2)
+      extras (~> 0.3)
+      liquid (>= 3.0, < 5.0)
+    listen (3.8.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    mercenary (0.3.6)
-    mini_magick (4.9.4)
-    namae (1.0.1)
+    mercenary (0.4.0)
+    mini_magick (4.12.0)
+    namae (1.1.1)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (4.0.7)
-    rack (1.6.12)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    public_suffix (5.0.3)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
-    ref (2.0.0)
-    rouge (3.12.0)
+    rexml (3.2.6)
+    rouge (4.1.3)
     safe_yaml (1.0.5)
-    sass (3.5.6)
+    sass (3.7.4)
       sass-listen (~> 4.0.0)
+    sass-embedded (1.64.2-aarch64-linux-gnu)
+      google-protobuf (~> 3.23)
+    sass-embedded (1.64.2-x86_64-linux-gnu)
+      google-protobuf (~> 3.23)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
-    sprockets (3.7.2)
-      concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    therubyracer (0.12.3)
-      libv8 (~> 3.16.14.15)
-      ref
-    trollop (2.1.2)
-    uglifier (2.7.2)
-      execjs (>= 0.3.0)
-      json (>= 1.8.0)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    trollop (2.9.9)
+    uglifier (4.2.0)
+      execjs (>= 0.3.0, < 3)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
-  ruby
+  aarch64-linux
+  x86_64-linux
 
 DEPENDENCIES
   autoprefixer-rails
+  bulma-clean-theme
   coffee-script
-  jekyll (>= 3.0)
-  jekyll-assets
+  jekyll (>= 4.2)
   jekyll-feed
   jekyll-paginate
   jekyll-scholar
   jekyll-sitemap
   jekyll-watch
   jgd
+  liquid-tag-parser
   mini_magick
   sass
-  therubyracer
   uglifier
 
 RUBY VERSION
-   ruby 2.4.1p111
+   ruby 3.2.2p53
 
 BUNDLED WITH
-   1.16.6
+   2.4.10

README.md

@@ -0,0 +1,69 @@
+# How to setup the project for local development
+
+## I. Requirements
+
+- You need docker installed on your computer
+  - Link to [Docker Engine](https://docs.docker.com/engine/install/)
+  - Link to [Docker Desktop (optional)](https://docs.docker.com/get-docker/)
+
+## II. Run the local development
+
+### Install all dependencies
+
+We use **docker** to *prevent version* and *system differences*. So please, especially if you are a mac user, use the docker container.
+
+#### Run this in your console to update your dependencies
+
+```bash
+docker-compose -f docker-compose-bundle.yml up
+```
+
+### Start the live preview of the page
+
+**Note:** The **live reload** of jekyll is not perfect. Therefore, **don't expect** it to work as intended. Sometimes, you need to <u>re-run the command</u> in order to see the **newest changes**.
+
+#### Run this in your console to start the local preview
+
+```bash
+docker-compose up
+```
+
+## III. Troubleshooting
+
+If the live preview fails and you don't know the cause, follow these steps:
+
+1. You installed the dependencies in the past
+
+    Chances are that the dependencies are not compatible if you once installed the dependencies a long time ago.
+
+    Steps to fix it:
+    - delete `vendor` folder
+    - delete `Gemfile.lock` folder
+    - re-install dependencies
+
+2. Your ports are already used by an other program
+
+    If you are running another program that requires either **port 4000** or **port 35729**, the preview will fail.
+
+    Steps to fix it:
+    - either close the program(s) that need(s) the port(s)
+    - or specify another port
+
+    If you want to specify another port go to the docker compose file, append one of the args to the bash script that the docker container will run:
+
+    - `--port [YOUR PORT]` (the port where the page is accessible at)
+    - `--livereload-port [YOUR PORT]` (the port where the live reload script is accessible at)
+
+    &rarr; append the arg(s) to the bash command:
+
+    ```bash
+     ... && bundle exec jekyll serve --livereload --host=0.0.0.0 --port=[PORT] --livereload-port=[PORT]
+    ```
+
+3. You decided not to run it in the docker container
+
+    If you did, then please run it in the container.
+
+4. Other causes
+
+    If you tried every troubleshooting method and none of them worked: We are sorry, but you need to find the error by your own.

Staging.Dockerfile

@@ -0,0 +1,3 @@
+FROM httpd:2.4
+
+COPY --chown=www-data:www-data _site /usr/local/apache2/htdocs/