Moving doc repository content here

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

.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: ".vendor/bundle"
+BUNDLE_DEPLOYMENT: "false"

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,113 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master", "develop"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# Allow canceling of the in-progress deployment now.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
+        with:
+          ruby-version: '3.1' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+
+      - name: Run custom preparation steps
+        run: |
+          echo "Updating navigation.yml"
+          pwd
+          
+          # Last param turns off jekyll build for the links, let it be done in the next step 
+          # with the same parameters we use for the real site build
+          #
+          ./_tools/navgen "./doc" "./_data/navigation.yml" "no"
+          
+          ls -Al _data/navigation.yml
+
+          # This one is just for sure to have our final scripts result inplace 
+          # as in the following _site build step the assets/js folder will be modified unfortunately
+          # Theoretically, the site build will not hurt the already presented files
+          # See bellow for more
+          #
+          echo "Updating main.min.js and re-pack js scripts"
+          pwd
+          
+          ./_tools/pack debug         
+          ls -AlR assets/js
+
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: |
+          # A double build is needed currently as the _data/links/ content must be rendered from the final html output, so
+          # the first run cannot use the not yet existing links
+          #
+          JEKYLL_BUILD_LINKS=yes bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+
+          JEKYLL_BUILD_TOOLTIPS=yes bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+
+          ls -AlR ./_site/assets/js          
+        env:
+          JEKYLL_ENV: production
+
+      - name: Run custom after build steps
+        # Seems jekyll build finds references from the minimal-mistakes bundle to the assets/js folder scripts
+        # even though most of them are packed in assets/js/main.min.js
+        # Re-packing only the required ones and overwrite the assets/js with the minimal result needed
+        # For more see the _tools/pack script
+        # TODO: Eliminate this later (probably building purely from local source the minimal-mistakes will solve this)
+        # TODO: Double-check if it's still needed
+        run: |
+          echo "Updating main.min.js and re-pack js scripts"
+          pwd
+          
+          ./_tools/pack debug
+          ls -AlR _site/assets/js
+
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,34 @@
+
+## macOS
+.DS_Store
+
+# Jekyll generated files
+.jekyll-cache
+.jekyll-metadata
+.sass-cache
+_asset_bundler_cache
+_site
+
+## Ruby Gem
+# excluded in _config.yml instead
+#.bundle
+*.gem
+.vendor
+Gemfile.lock
+
+## Node.js and NPM
+node_modules
+npm-debug.log*
+package-lock.json
+codekit-config.json
+
+## Misc
+.reftime
+
+# Generated files, must be regenerated during distribution always
+# These added back with warning headers to aid instant usage
+#_data/navigation.yml
+_data/links
+# _js/main.min.js
+assets/js
+_tools/package.json

Gemfile

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# 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:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+#
+# To upgrade, run `bundle update`.
+
+# The actual (07. febr. 2024) GitHub Pages dependency list got during CI builds
+# (Do not believe the outdated info at https://pages.github.com/versions/ :S )
+# 
+# addressable 2.8.6
+# base64 0.2.0
+# bigdecimal 3.1.6
+# bundler 2.3.26
+# colorator 1.1.0
+# concurrent-ruby 1.2.3
+# csv 3.2.8
+# em-websocket 0.5.3
+# eventmachine 1.2.7
+# faraday 2.9.0
+# faraday-net_http 3.1.0
+# faraday-retry 2.2.0
+# ffi 1.16.3
+# forwardable-extended 2.6.0
+# google-protobuf 3.25.2 (x86_64-linux)
+# http_parser.rb 0.8.0
+# i18n 1.14.1
+# jekyll 4.3.3
+# jekyll-feed 0.17.0
+# jekyll-gist 1.5.0
+# jekyll-include-cache 0.2.1
+# jekyll-paginate 1.1.0
+# jekyll-remote-theme 0.4.3
+# jekyll-sass-converter 3.0.0
+# jekyll-sitemap 1.4.0
+# jekyll-watch 2.2.1
+# kramdown 2.4.0
+# kramdown-parser-gfm 1.1.0
+# liquid 4.0.4
+# listen 3.8.0
+# mercenary 0.4.0
+# minimal-mistakes-jekyll 4.24.0
+# net-http 0.4.1
+# octokit 4.25.1
+# pathutil 0.16.2
+# public_suffix 5.0.4
+# rake 13.1.0
+# rb-fsevent 0.11.2
+# rb-inotify 0.10.1
+# rexml 3.2.6
+# rouge 4.2.0
+# rubyzip 2.3.2
+# safe_yaml 1.0.5
+# sass-embedded 1.70.0 (x86_64-linux-gnu)
+# sawyer 0.9.2
+# terminal-table 3.0.2
+# unicode-display_width 2.5.0
+# uri 0.13.0
+# webrick 1.8.1
+# 
+# So, jekyll 4.3.3 is used by GitHub already!
+# Try to use it in your own dev env as well!
+#
+# Dependeny hell, let "minimal-mistakes-jekyll" decide and add missing ones one-by one
+#gem "jekyll", "~> 4.3.3"
+
+#
+# FIXME: Get rid of the chaos, use clean local theme copy, we added a bunch of enhancements already, so
+# we don't really need the bundled, updated version anymore
+#
+# https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+#
+gem "minimal-mistakes-jekyll"
+
+gem "rake"
+gem "csv"
+gem "base64"
+gem "bigdecimal"
+gem "faraday-retry"
+# take care, the default dependency of minimal-mistakes-jekyll.4.24.0 is mercenary-0.3.6
+# that could lead to build error:
+# /opt/homebrew/Cellar/ruby/3.3.0/lib/ruby/3.3.0/logger.rb:384:in `level': undefined method `[]' for nil (NoMethodError)
+#    @level_override[Fiber.current] || @level
+gem "mercenary", "~> 0.4"
+
+# self made plugins dependencies
+gem "nokogiri"
+
+# Gems loaded irrespective of site configuration.
+# If you have any other plugins, put them here!
+# Cf. https://jekyllrb.com/docs/plugins/installation/
+group :jekyll_plugins do
+
+    gem "jekyll-remote-theme"
+    # gem "jekyll-paginate"
+    # gem "jekyll-sitemap"
+    # gem "jekyll-gist"
+
+    # Doc mentiones only these are needed if using remote
+    # https://github.com/HofiOne/minimal-mistakes
+    #
+    gem "jekyll-include-cache"
+    # gem "github-pages"
+end