Merge branch 'staging' of github.com:SovereignCloudStack/website into staging

Author: scoopex

.dockerignore

@@ -0,0 +1,3 @@
+.git
+node_modules
+vendor

.github/workflows/checks.yml

@@ -10,7 +10,7 @@ jobs:
     name: "Lighthouse v9 performance checks"
     runs-on: ubuntu-latest
     steps:
-      - uses: treosh/lighthouse-ci-action@v11
+      - uses: treosh/lighthouse-ci-action@v12
         with:
           urls: https://scs.community
           uploadArtifacts: true # save results as an action artifacts

Containerfile.jekyll-action

@@ -0,0 +1,32 @@
+# Inspired by https://github.com/helaili/jekyll-action/tree/2.4.0
+
+FROM ruby:2.7-alpine
+
+ENV LC_ALL=C.UTF-8
+ENV LANG=C.UTF-8
+
+RUN apk add --no-cache --update git build-base bash vips uglify-js musl
+
+# Allow for timezone setting in _config.yml
+RUN apk add --update tzdata
+
+# Use curl to send API requests
+RUN apk add --update curl
+
+RUN addgroup -Sg 1000 jekyll && \
+    adduser -Su 1000 -G jekyll jekyll
+
+RUN gem install bundler -v 2.4.22  && \
+       bundle config set force_ruby_platform true
+
+#COPY --chown=jekyll:jekyll ./ /srv/jekyll
+
+# debug
+RUN bundle version
+
+COPY --chmod=0755 entrypoint.sh /
+
+USER jekyll
+WORKDIR /srv/jekyll
+
+ENTRYPOINT ["/entrypoint.sh"]

Containerfile.node16

@@ -0,0 +1,12 @@
+# Loads and runs npm/node from a specific version. Depends on the working
+# directory to be mounted at /data.
+
+# As of 2024-08-27 this is the version used in the repo
+FROM node:16.20.2-alpine3.18
+
+WORKDIR /data
+
+RUN npm install
+
+# Result: building this container creates/updates the node_modules folder
+# in the work directory.

Dockerfile.jekyll

@@ -0,0 +1,27 @@
+# This file is an alternative to Containerfile.jekyll-action and uses
+# the jekyll/builder image directly.
+
+# ruby 2.7.1 - in use by Github action, as of 2024-08-27
+FROM docker.io/jekyll/builder:4.2.0
+
+# ruby 3.1.1
+#FROM docker.io/jekyll/builder:4.2.2
+
+RUN apk add --update vips uglify-js musl git build-base tzdata curl bash
+
+RUN addgroup -Sg 1000 jekyll && adduser -Su 1000 -G jekyll jekyll
+
+#COPY --chown=jekyll:jekyll ./ /srv/jekyll
+
+COPY --chmod=755 entrypoint.sh /usr/local/bin/entrypoint.sh
+
+RUN gem install bundler -v 2.4.22  && \
+       bundle config set force_ruby_platform true
+
+RUN bundle version
+
+USER jekyll
+WORKDIR /srv
+
+ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
+

Gemfile.lock

@@ -23,19 +23,22 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.4)
+    activesupport (7.2.2)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
+    benchmark (0.3.0)
     bibtex-ruby (6.1.0)
       latex-decode (~> 0.0)
       racc (~> 1.7)
@@ -47,7 +50,7 @@ GEM
       citeproc (~> 1.0, >= 1.0.9)
       csl (~> 1.6)
     colorator (1.1.0)
-    concurrent-ruby (1.3.1)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     csl (1.6.0)
       namae (~> 1.0)
@@ -59,19 +62,23 @@ GEM
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
-    execjs (2.9.1)
+    execjs (2.10.0)
     extras (0.3.0)
       forwardable-extended (~> 2.5)
     fastimage (2.3.1)
+    ffi (1.17.0)
     ffi (1.17.0-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
-    google-protobuf (4.27.0-x86_64-linux)
+    google-protobuf (4.28.2)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.28.2-x86_64-linux)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
-    jekyll (4.3.3)
+    jekyll (4.3.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -119,50 +126,58 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.1)
     mercenary (0.4.0)
-    minitest (5.23.1)
-    mutex_m (0.2.0)
+    mini_portile2 (2.8.7)
+    minitest (5.25.1)
     namae (1.2.0)
       racc (~> 1.7)
-    nokogiri (1.16.5-x86_64-linux)
+    nokogiri (1.16.7)
+      mini_portile2 (~> 2.8.2)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.5)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rack (3.0.9.1)
     rake (13.2.1)
     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)
+    rexml (3.3.9)
+    rouge (4.3.0)
     rqrcode (2.2.0)
       chunky_png (~> 1.0)
       rqrcode_core (~> 1.0)
     rqrcode_core (1.2.0)
-    ruby-vips (2.2.1)
+    ruby-vips (2.2.2)
       ffi (~> 1.12)
+      logger
     safe_yaml (1.0.5)
-    sass-embedded (1.77.4-x86_64-linux-gnu)
-      google-protobuf (>= 3.25, < 5.0)
+    sass-embedded (1.78.0)
+      google-protobuf (~> 4.27)
+      rake (>= 13)
+    sass-embedded (1.78.0-x86_64-linux-gnu)
+      google-protobuf (~> 4.27)
     sassc (2.4.0)
       ffi (~> 1.9)
+    securerandom (0.3.1)
     sprockets (4.2.1)
       concurrent-ruby (~> 1.0)
       rack (>= 2.2.4, < 4)
-    strscan (3.1.0)
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    uglifier (4.2.0)
+    uglifier (4.2.1)
       execjs (>= 0.3.0, < 3)
-    unicode-display_width (2.5.0)
-    webrick (1.8.1)
+    unicode-display_width (2.6.0)
+    webrick (1.8.2)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

README.md

@@ -3,7 +3,7 @@
 
 The static [SCS website](https://scs.community) is generated by [Jekyll](https://jekyllrb.com/). The theme is originally based on the template [business-frontpage](https://github.com/sharu725/business-frontpage) by [sharu725](https://github.com/sharu725). We're heavily making use of [Bootstrap 5](https://getbootstrap.com/docs/5.0) to layout the page content.
 
-The website is automatically build every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
+The website is automatically built every 15 minutes or on every push to `main` and subsequently pulled onto our webspace.
 
 ## Locations
 
@@ -20,20 +20,18 @@ Published sites:
    ![Step 2](_assets/doc/step2.png)
 2. Make your changes in the branch
    ![Step 3](_assets/doc/step3.png)
-3. Create a pull request to get the changes in the `main` branch
+3. Create a pull request to get the changes into the `main` branch
    * Open https://github.com/SovereignCloudStack/website
    * Select `Contribute` -> `Open pull request`
      * Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
-     * Add a optional description
+     * Add an optional description
      * `Create pull request`
    * Assign one ore more persons which can review the changes and remind the person to review the change
 4. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
-   * If there is something to todo, you can restart at step 2
-   * If everything is fine the reviewer approves the merge request
+   * If there is something to do, you can restart at step 2
+   * If everything is fine, the reviewer approves the merge request
    * Your changes are merged to the `main` branch and rolled out after 15 minutes
 
-
-
 ## The editorial workflow
 
 The website data is deployed by the following process:
@@ -50,7 +48,7 @@ The description is a little more detailed than it needs to be, as it aims also t
    cd website
    git checkout main
    git pull
-   git checkout -b feat/<name of your branch> # not not use spaces
+   git checkout -b feat/<name of your branch> # do not use spaces
    ```
 2. Make your changes with the tool of your choice
 3. Commit and push with signoffs
@@ -60,16 +58,16 @@ The description is a little more detailed than it needs to be, as it aims also t
    git add <file> ... <file>
    git status
    git commit -s -a
-   gut push
+   git push -u origin feat/<name of your branch>
    ```
-4. Optional: Testing complexer changes
+4. Optional: Testing more complex changes
   * Set the `staging` branch to the same state like the main branch
      ```
      git checkout staging
      # check the current difference
      git diff main
 
-     # This abdondons everything on the staging branch
+     # This abandons everything on the staging branch
      git reset --hard origin/main
      # add changes of other branches
      git merge feat/<name of your branch>
@@ -79,26 +77,26 @@ The description is a little more detailed than it needs to be, as it aims also t
      git push --force
      ```
   * Test the result: https://staging.scs.community/ (that takes ~15minutes)
-  * Start at Step 2 if your are not satisfied
+  * Start again at Step 2 if you are not satisfied
 5. Create a pull request to get the changes in the `main` branch
    * Open https://github.com/SovereignCloudStack/website
    * Select `Contribute` -> `Open pull request`
      * Verify that `base: main` and `compare <your branch>` is selected in the top of the pull request
-     * Add a optional description
+     * Add an optional description
      * `Create pull request`
    * Assign one ore more persons which can review the changes and remind the person to review the change
 6. The [reviewer](https://github.com/pulls/assigned) inspects [your](https://github.com/pulls) changes and gives feedback
-   * If there is something to todo, you can restart at step 2
-   * If everything is fine the reviewer approves the merge request
+   * If there is something to do, you can restart at step 2
+   * If everything is fine, the reviewer approves the merge request
    * Your changes are merged to the `main` branch and rolled out after 15 minutes
 
 ## Frequently asked questions
 
 ### How can I publish a community blog posting?
-Create a markup document located at `_i18n/en/blog` and/or respectively `_i18n/de/blog`  to add a new blog post. Be aware that the file shall be named `YEAR-MONTH-DAY-title.MARKUP` according to the Jekyll conventions (see [Jekyll Docs](https://jekyllrb.com/docs/posts/)).
+Create a markup document located at `_i18n/en/blog` and/or respectively `_i18n/de/blog` to add a new blog post. Be aware that the file shall be named `YEAR-MONTH-DAY-title.MARKUP` according to the Jekyll conventions (see [Jekyll Docs](https://jekyllrb.com/docs/posts/)).
 
 ### How can I create a new page?
-Due to the internalization plugin, you have to create multiple files. First of all, add a new markup document under `_pages`, set the desired layout, e.g. `default` and add the line
+Due to the internationalization plugin, you have to create multiple files. First of all, add a new markup document under `_pages`, set the desired layout, e.g. `default` and add the line
 ```
 {% tf pagetitle.MARKUP %}
 ```
@@ -115,16 +113,18 @@ As we're using Bootstrap, please add your custom styling definitions to `assets/
 
 ## Testing changes on `staging` branch
 
-We're using a dedicated workflow to build a staging preview of our website that subsequently is published with GitHub Pages. To make use of this feature, simply push to `staging`. Please try to keep `staging` in sync with `main`, e.g. by deleting and recreating after testing your recent changes. The staging area can be reached via <https://sovereigncloudstack.github.io/website/>.
+We're using a dedicated workflow to build a staging preview of our website that subsequently is published with GitHub Pages. To make use of this feature, simply push to the `staging` branch. Please try to keep `staging` in sync with `main`, e.g. by deleting and recreating after testing your recent changes. The staging area can be reached via <https://sovereigncloudstack.github.io/website/>.
 
 ## Testing changes locally
 
+As of August 2024, the local build is aimed at a podman-based container installation.
+
 * Clone Repo
   ```
   git clone [email protected]:SovereignCloudStack/website.git
   ```
 * Start testserver
   ```
-  ./run.sh
+  bash run-podman.sh
   ```