Fixes (fire2a#28)

- docs -> site
- Containerfile to local live serve
- content updates


* rename for simpler url

* title page updates

* remove deprecated dialog

* cookbook restart

* library restart

* management update

* getting help isolated

* remade plugin install videos

* cleanup

* algo.lib order + links in navigation

* small improv

* container also just serve

* algo.lib. nav order

* renamed moved to site

* action and container moved to site

* updated links to site

* fix readme

* toolbox img fixes

* c2f fixes

* container fix?

* fixes

* fix

* fixlink

* fix

* fixurl

* fixurl

* fixurl

* fixurl

* fix

* fixurl

* last pic

---------

Co-authored-by: fdobad <[email protected]>

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: bundler
-    directory: /
+    directory: /site
     schedule:
       interval: daily
     allow:

.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,6 +40,7 @@ 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
@@ -48,6 +52,8 @@ jobs:
       - name: Upload artifact
         # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v1
+        with:
+          path: "site/_site/"
 
   # Deployment job
   deploy:

Containerfile

@@ -11,6 +11,12 @@ RUN apt-get update && \
     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
 
-ENTRYPOINT ["/bin/bash"]
+CMD ["/build_n_serve.sh"]

README.md

@@ -1,32 +1,43 @@
-# 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
+
+# build the container named fire2a_docs
+podman build -t fire2a_docs .
+
+# build_n_serve.sh is the default command
+podman run -it --rm -v ./site:/app -p 35729:35729 -p 4000:4000 fire2a_docs
 
-## local hosting on debian
-### install
+# or just serve (after build)
+podman run -it --rm -v $(pwd):/app -p 35729:35729 -p 4000:4000 fire2a_docs /serve.sh
+```
+
+### Local hosting on debian
+#### install
 ```bash
 sudo apt-get install ruby-full ruby-bundler jekyll build-essential
 ```
-### build
+#### build
 ```
 cd <repo/root>
 bundle config set --local path 'vendor/bundle'
 bundle install
 ```
-### live serve
+#### live serve
 Editing and saving will automatically update the page.  
 ```bash
 bundle exec jekyll serve --livereload
@@ -35,7 +46,8 @@ 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.
 ```
-### update just-the-docs
+
+## 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
@@ -50,7 +62,7 @@ bundle clean --force
 # rebuild
 ```
 
-### references
+## references
 https://github.com/just-the-docs/just-the-docs  
 https://jekyllrb.com/docs/installation/other-linux/  
 

rebuild_serve.sh → build_n_serve.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 set -x
 
-git clean -dfX
+cd /app
+# git clean -dfX # messes unchanged files
 rm -f Gemfile.lock
 rm -fr .bundle vendor/bundle
 bundle clean --force

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}