firebreak bump

.github/dependabot.yml

@@ -1,8 +1,13 @@
 version: 2
 updates:
-  - package-ecosystem: bundler
-    directory: /
+  - package-ecosystem: "bundler"
+    directory: "/site"
     schedule:
-      interval: daily
+      interval: "weekly"
     allow:
-      - dependency-type: direct
+      - dependency-type: "direct"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yml

@@ -1,8 +1,8 @@
 name: CI
 
 on:
-  push:
-    branches: ["main"]
+  # push:
+  #   branches: ["main"]
   pull_request:
 
 jobs:
@@ -19,4 +19,4 @@ jobs:
           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: Build with Jekyll
-        run: bundle exec jekyll build
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"

.github/workflows/pages.yml

@@ -28,6 +28,9 @@ jobs:
   # Build job
   build:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: site
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -37,17 +40,20 @@ jobs:
           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
+          working-directory: '${{ github.workspace }}/site'
       - name: Setup Pages
         id: pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v5
       - name: Build with Jekyll
         # Outputs to the './_site' directory by default
         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "site/_site/"
 
   # Deployment job
   deploy:
@@ -59,4 +65,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

Containerfile

@@ -0,0 +1,22 @@
+FROM debian:stable
+
+ENV DEBIAN_FRONTEND=noninteractive
+
+RUN apt-get update && \
+    apt-get install -y \
+    ruby-full \
+    ruby-bundler \
+    jekyll \
+    build-essential \
+    git \
+    vim-tiny
+
+COPY serve.sh /serve.sh
+RUN chmod +x /serve.sh
+
+COPY build_n_serve.sh /build_n_serve.sh
+RUN chmod +x /build_n_serve.sh
+
+EXPOSE 4000 35729
+
+CMD ["/build_n_serve.sh"]

README.md

@@ -1,38 +1,68 @@
-# Fire2a documentation repo
+# Fire2a user documentation webpage
 
-This repo uses the [just-the-docs-template](https://github.com/just-the-docs/just-the-docs-template) Jekyl Pages action.  
-The source for its content is in the docs directory.  
-Check the live [page](https://fire2a.github.io/docs/).  
+This "GitHub Pages" hosted page is published [here](https://fire2a.github.io/docs/)
 
-## About Us
+Using [just-the-docs-template](https://github.com/just-the-docs/just-the-docs-template) Jekyll Pages action
 
-We are a research group that seeks solutions to complex problems arising from the terrestrial ecosystem and its natural and anthropogenic disturbances,such as wildfires.
+The content is located in `site` directory, and it is mainly just markdown files
 
-Currently hosted at [ISCI](https://isci.cl) offices.
+## Contributing
+Please feel free to contribute by opening a pull request, to preview your changes locally, you can use the following methods:
 
-Contact us at <a href="mailto:[email protected]">[email protected]</a>.
+### Container
+This setup will build the Jekyll site inside the container and serve it with live reload enabled.
 
-[content licence](./LICENCE)
-[just-the-docs-licence](./just-the-docs-LICENCE)
+You can access the site at `http://localhost:4000` after running the container.
+```bash
+sudo apt install podman
 
-## local hosting on debian
-### install
+# build the container named fire2a_docs
+podman build -t fire2a_docs .
 
-    sudo apt-get install ruby-full ruby-bundler jekyll build-essential
-    cd repo/root/
-    bundle config set --local path 'vendor/bundle'
-    bundle install
+# build_n_serve.sh is the default command
+podman run -it --rm -v ./site:/app -p 35729:35729 -p 4000:4000 fire2a_docs
 
-### serve
+# or just serve (after build)
+podman run -it --rm -v $(pwd):/app -p 35729:35729 -p 4000:4000 fire2a_docs /serve.sh
+```
 
-    bundle exec jekyll serve --livereload
+### Local hosting on debian
+#### install
+```bash
+sudo apt-get install ruby-full ruby-bundler jekyll build-essential
+```
+#### build
+```
+cd <repo/root>
+bundle config set --local path 'vendor/bundle'
+bundle install
+```
+#### live serve
+Editing and saving will automatically update the page.  
+```bash
+bundle exec jekyll serve --livereload
+...
+LiveReload address: http://127.0.0.1:35729
+    Server address: http://127.0.0.1:4000  <--- OPEN IN BROWSER
+  Server running... press ctrl-c to stop.
+```
 
-    # ctrl+click here to open
-    ...
-    Server address: http://127.0.0.1:4000
-    ...
+## update just-the-docs dependencies
+Dependabot will automatically create a pull request to update the just-the-docs version.
+```bash
+git switch dependabot/bundler/just-the-docs-0.8.2
+# check compatibility
+ruby -v
+node -v
+# clean
+git clean -dfX -n
+rm Gemfile.lock
+rm -r .bundle vendor/bundle
+bundle clean --force
+# rebuild
+```
 
-### references
-https://github.com/just-the-docs/just-the-docs
-https://jekyllrb.com/docs/installation/other-linux/
+## references
+https://github.com/just-the-docs/just-the-docs  
+https://jekyllrb.com/docs/installation/other-linux/  
 

build_n_serve.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -x
+
+cd /app
+# git clean -dfX # messes unchanged files
+rm -f Gemfile.lock
+rm -fr .bundle vendor/bundle
+bundle clean --force
+bundle config set --local path 'vendor/bundle'
+bundle install
+bundle exec jekyll serve --livereload --host 0.0.0.0 --force_polling

convert.sh

@@ -0,0 +1,37 @@
+#!/bin/bash
+
+# 1
+# Find all .gif files recursively from the current directory
+find . -type f -name "*.gif" | while read -r gif_file; do
+  # Extract the base name without the extension
+  base_name="${gif_file%.*}"
+
+  # Define the new filename with .mp4 extension
+  mp4_file="${base_name}.mp4"
+
+  # Use ffmpeg to convert the gif to mp4
+  echo "Converting $gif_file to $mp4_file"
+  # ffmpeg -i "$gif_file" "$mp4_file"
+  ffmpeg -i $gif_file -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" $mp4_file
+
+  echo "Converted $gif_file to $mp4_file"
+done
+
+# 2
+# manual
+gif_file=qgis_windows_activate_venv.gif
+base_name="${gif_file%.*}"
+mp4_file="${base_name}.mp4"
+rm $mp4_file
+ffmpeg -i $gif_file -movflags faststart -pix_fmt yuv420p -vf "scale=trunc(iw/2)*2:trunc(ih/2)*2" $mp4_file
+
+# 3
+# check
+find . -type f -name "*.gif" | while read -r gif_file; do
+  # Extract the base name without the extension
+  base_name="${gif_file%.*}"
+  # Define the new filename with .mp4 extension
+  mp4_file="${base_name}.mp4"
+  ls -lh $gif_file $mp4_file
+  echo "Converted $gif_file to $mp4_file"
+done

docs/qgis-dialog/README.md → deprecated/qgis-dialog/README.md

@@ -1,10 +1,10 @@
----
-layout: default
-title: QGIS dialog DEPRECATED
-nav_order: 97
-has_children: true
-has_toc: false
----
+# ---
+# layout: default
+# title: QGIS dialog DEPRECATED
+# nav_order: 97
+# has_children: true
+# has_toc: false
+# ---
 
 # Cell 2 Fire QGIS plugin
 {: .no_toc}
@@ -42,7 +42,10 @@ This softwares enables you to simulate thousand of forest fires on a landscape u
 4. [Install the plugin inside QGIS](#activate)
 
 <figure>
-    <img src="img/win_install_script.gif" width=66% alt='missing'>
+    <video controls loop style="width: 66%;">
+        <source src="img/win_install_script.mp4" type="video/mp4">
+        Your browser does not support the video tag.
+    </video>
     <figcaption>executing installer</figcaption>
 </figure>