opengisch · signedav · Feb 15, 2024 · Feb 15, 2024 · Feb 15, 2024 · Feb 15, 2024
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+
+  - package-ecosystem: "pip"
+    directory: "docs/"
+    schedule:
+      interval: "monthly"
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -1,11 +1,26 @@
 name: doc
 on:
+  pull_request:
+    branches:
+      - master
+    paths:
+      - 'docs/**'
+      - '.github/workflows/doc.yml'
   push:
     branches:
       - master
     paths:
       - 'docs/**'
       - '.github/workflows/doc.yml'
+  workflow_dispatch: # useful for testing tx pushes
+  workflow_call:
+
+permissions:
+  contents: write
+
+defaults:
+  run:
+    working-directory: docs
 
 jobs:
   deploy:
@@ -16,40 +31,48 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
       - name: Checkout Python
         uses: actions/setup-python@v4
         with:
           python-version: '3.10'
 
       - name: Install Python requirements
-        run: pip install -r ./docs/.utils/requirements.txt
+        run: pip install -r requirements.txt
 
       - name: Install Transifex client
         run: |
           curl -OL https://github.com/transifex/cli/releases/download/v1.6.10/tx-linux-amd64.tar.gz
           tar -xvzf tx-linux-amd64.tar.gz
 
       - name: Configure Transifex
-        run: |
-          python ./docs/.utils/transifex_utils.py
+        run: scripts/transifex_utils.py
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
       - name: Push source files to Transifex
-        run: |
-          ./tx push
+        if: ${{ github.event_name == 'push' }}
+        run: ./tx push
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
       - name: Pull translations from Transifex
+        if: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == 'opengisch/QgisModelBaker' }}
         run: |
           ./tx pull --translations --all --minimum-perc 10
           ./tx status
         env:
           TX_TOKEN: ${{ secrets.TX_TOKEN }}
 
-      - name: Build docs
+      - name: Build documentation
+        run: mkdocs build
+
+      - uses: actions/upload-artifact@v4
+        if: ${{ github.event_name == 'pull_request' }}
+        with:
+          name: docs
+          path: docs/site
+          if-no-files-found: error
+
+      - name: Deploy to GitHub Pages
+        if: ${{ github.event_name == 'push' }}
         run: mkdocs gh-deploy --force
diff --git a/.tx/config → docs/.tx/config b/.tx/config → docs/.tx/config
diff --git a/docs/.utils/requirements.txt b/docs/.utils/requirements.txt
diff --git a/docs/assets/arrow_button.png → docs/docs/assets/arrow_button.png b/docs/assets/arrow_button.png → docs/docs/assets/arrow_button.png
diff --git a/docs/assets/baskets_dataset_manager.png → docs/docs/assets/baskets_dataset_manager.png b/docs/assets/baskets_dataset_manager.png → docs/docs/assets/baskets_dataset_manager.png
diff --git a/docs/assets/catalogues_form.png → docs/docs/assets/catalogues_form.png b/docs/assets/catalogues_form.png → docs/docs/assets/catalogues_form.png
diff --git a/docs/assets/catalogues_relationeditor.png → ...docs/assets/catalogues_relationeditor.png b/docs/assets/catalogues_relationeditor.png → ...docs/assets/catalogues_relationeditor.png
diff --git a/docs/assets/catalogues_treevalidation.png → ...docs/assets/catalogues_treevalidation.png b/docs/assets/catalogues_treevalidation.png → ...docs/assets/catalogues_treevalidation.png
diff --git a/docs/assets/catalogues_withoutvalidation.png → ...s/assets/catalogues_withoutvalidation.png b/docs/assets/catalogues_withoutvalidation.png → ...s/assets/catalogues_withoutvalidation.png
diff --git a/docs/assets/checkmark_button.png → docs/docs/assets/checkmark_button.png b/docs/assets/checkmark_button.png → docs/docs/assets/checkmark_button.png
diff --git a/docs/assets/dataset_basket_manager.png → docs/docs/assets/dataset_basket_manager.png b/docs/assets/dataset_basket_manager.png → docs/docs/assets/dataset_basket_manager.png
diff --git a/docs/assets/dataset_manager.png → docs/docs/assets/dataset_manager.png b/docs/assets/dataset_manager.png → docs/docs/assets/dataset_manager.png
diff --git a/docs/assets/dataset_relation_reference.png → ...ocs/assets/dataset_relation_reference.png b/docs/assets/dataset_relation_reference.png → ...ocs/assets/dataset_relation_reference.png
diff --git a/...ets/dataset_relation_reference_domain.png → ...ets/dataset_relation_reference_domain.png b/...ets/dataset_relation_reference_domain.png → ...ets/dataset_relation_reference_domain.png
diff --git a/docs/assets/dataset_selector.png → docs/docs/assets/dataset_selector.png b/docs/assets/dataset_selector.png → docs/docs/assets/dataset_selector.png
diff --git a/docs/assets/drag_arrows_button.png → docs/docs/assets/drag_arrows_button.png b/docs/assets/drag_arrows_button.png → docs/docs/assets/drag_arrows_button.png
diff --git a/docs/assets/extended-models-baskets-all.png → ...cs/assets/extended-models-baskets-all.png b/docs/assets/extended-models-baskets-all.png → ...cs/assets/extended-models-baskets-all.png
diff --git a/...sets/extended-models-baskets-relevant.png → ...sets/extended-models-baskets-relevant.png b/...sets/extended-models-baskets-relevant.png → ...sets/extended-models-baskets-relevant.png
diff --git a/docs/assets/extended-models-group.png → docs/docs/assets/extended-models-group.png b/docs/assets/extended-models-group.png → docs/docs/assets/extended-models-group.png
diff --git a/docs/assets/extended-models-hide.png → docs/docs/assets/extended-models-hide.png b/docs/assets/extended-models-hide.png → docs/docs/assets/extended-models-hide.png
diff --git a/docs/assets/extended-models-none.png → docs/docs/assets/extended-models-none.png b/docs/assets/extended-models-none.png → docs/docs/assets/extended-models-none.png
diff --git a/docs/assets/file_browser_button.png → docs/docs/assets/file_browser_button.png b/docs/assets/file_browser_button.png → docs/docs/assets/file_browser_button.png
diff --git a/docs/assets/generated_project.png → docs/docs/assets/generated_project.png b/docs/assets/generated_project.png → docs/docs/assets/generated_project.png
diff --git a/docs/assets/menu.png → docs/docs/assets/menu.png b/docs/assets/menu.png → docs/docs/assets/menu.png
diff --git a/...ts/meta_attributes_relation_reference.png → ...ts/meta_attributes_relation_reference.png b/...ts/meta_attributes_relation_reference.png → ...ts/meta_attributes_relation_reference.png
diff --git a/docs/assets/modelbaker_icon.svg → docs/docs/assets/modelbaker_icon.svg b/docs/assets/modelbaker_icon.svg → docs/docs/assets/modelbaker_icon.svg
diff --git a/docs/assets/modelbaker_logo_long.svg → docs/docs/assets/modelbaker_logo_long.svg b/docs/assets/modelbaker_logo_long.svg → docs/docs/assets/modelbaker_logo_long.svg
diff --git a/docs/assets/oid_physical_data.png → docs/docs/assets/oid_physical_data.png b/docs/assets/oid_physical_data.png → docs/docs/assets/oid_physical_data.png
diff --git a/docs/assets/oid_tid_manager.png → docs/docs/assets/oid_tid_manager.png b/docs/assets/oid_tid_manager.png → docs/docs/assets/oid_tid_manager.png
diff --git a/docs/assets/plus_button.png → docs/docs/assets/plus_button.png b/docs/assets/plus_button.png → docs/docs/assets/plus_button.png
diff --git a/docs/assets/settings_general.png → docs/docs/assets/settings_general.png b/docs/assets/settings_general.png → docs/docs/assets/settings_general.png
diff --git a/docs/assets/settings_ili2db.png → docs/docs/assets/settings_ili2db.png b/docs/assets/settings_ili2db.png → docs/docs/assets/settings_ili2db.png
diff --git a/docs/assets/settings_interlis.png → docs/docs/assets/settings_interlis.png b/docs/assets/settings_interlis.png → docs/docs/assets/settings_interlis.png
diff --git a/docs/assets/toolbar.png → docs/docs/assets/toolbar.png b/docs/assets/toolbar.png → docs/docs/assets/toolbar.png
diff --git a/docs/assets/upgrade_create.png → docs/docs/assets/upgrade_create.png b/docs/assets/upgrade_create.png → docs/docs/assets/upgrade_create.png
diff --git a/docs/assets/upgrade_export_data.png → docs/docs/assets/upgrade_export_data.png b/docs/assets/upgrade_export_data.png → docs/docs/assets/upgrade_export_data.png
diff --git a/docs/assets/upgrade_import_data.png → docs/docs/assets/upgrade_import_data.png b/docs/assets/upgrade_import_data.png → docs/docs/assets/upgrade_import_data.png
diff --git a/docs/assets/upgrade_import_schema.png → docs/docs/assets/upgrade_import_schema.png b/docs/assets/upgrade_import_schema.png → docs/docs/assets/upgrade_import_schema.png
diff --git a/docs/assets/usabilityhub_ili2dboptions.png → ...ocs/assets/usabilityhub_ili2dboptions.png b/docs/assets/usabilityhub_ili2dboptions.png → ...ocs/assets/usabilityhub_ili2dboptions.png
diff --git a/docs/assets/usabilityhub_legend_entry.png → ...docs/assets/usabilityhub_legend_entry.png b/docs/assets/usabilityhub_legend_entry.png → ...docs/assets/usabilityhub_legend_entry.png
diff --git a/docs/assets/usabilityhub_localrepo.png → docs/docs/assets/usabilityhub_localrepo.png b/docs/assets/usabilityhub_localrepo.png → docs/docs/assets/usabilityhub_localrepo.png
diff --git a/docs/assets/usabilityhub_multimodels.png → .../docs/assets/usabilityhub_multimodels.png b/docs/assets/usabilityhub_multimodels.png → .../docs/assets/usabilityhub_multimodels.png
diff --git a/.../assets/usabilityhub_original_project.png → .../assets/usabilityhub_original_project.png b/.../assets/usabilityhub_original_project.png → .../assets/usabilityhub_original_project.png
diff --git a/docs/assets/usabilityhub_qgis_legend.png → .../docs/assets/usabilityhub_qgis_legend.png b/docs/assets/usabilityhub_qgis_legend.png → .../docs/assets/usabilityhub_qgis_legend.png
diff --git a/docs/assets/usabilityhub_raw_import.png → docs/docs/assets/usabilityhub_raw_import.png b/docs/assets/usabilityhub_raw_import.png → docs/docs/assets/usabilityhub_raw_import.png
diff --git a/docs/assets/usabilityhub_raw_import_toml.png → ...s/assets/usabilityhub_raw_import_toml.png b/docs/assets/usabilityhub_raw_import_toml.png → ...s/assets/usabilityhub_raw_import_toml.png
diff --git a/docs/assets/usabilityhub_save_qml.png → docs/docs/assets/usabilityhub_save_qml.png b/docs/assets/usabilityhub_save_qml.png → docs/docs/assets/usabilityhub_save_qml.png
diff --git a/docs/assets/usabilityhub_style.png → docs/docs/assets/usabilityhub_style.png b/docs/assets/usabilityhub_style.png → docs/docs/assets/usabilityhub_style.png
diff --git a/docs/assets/usabilityhub_toml_config.png → .../docs/assets/usabilityhub_toml_config.png b/docs/assets/usabilityhub_toml_config.png → .../docs/assets/usabilityhub_toml_config.png
diff --git a/docs/assets/usabilityhub_uml.png → docs/docs/assets/usabilityhub_uml.png b/docs/assets/usabilityhub_uml.png → docs/docs/assets/usabilityhub_uml.png
diff --git a/docs/assets/usabilityhub_uml_modelbaker.png → ...cs/assets/usabilityhub_uml_modelbaker.png b/docs/assets/usabilityhub_uml_modelbaker.png → ...cs/assets/usabilityhub_uml_modelbaker.png
diff --git a/docs/assets/validation.png → docs/docs/assets/validation.png b/docs/assets/validation.png → docs/docs/assets/validation.png
diff --git a/docs/assets/validation_configfile.png → docs/docs/assets/validation_configfile.png b/docs/assets/validation_configfile.png → docs/docs/assets/validation_configfile.png
diff --git a/.../assets/validation_skipgeometryerrors.png → .../assets/validation_skipgeometryerrors.png b/.../assets/validation_skipgeometryerrors.png → .../assets/validation_skipgeometryerrors.png
diff --git a/docs/assets/workflow_wizard_data_import.png → ...cs/assets/workflow_wizard_data_import.png b/docs/assets/workflow_wizard_data_import.png → ...cs/assets/workflow_wizard_data_import.png
diff --git a/...sets/workflow_wizard_db_configuration.png → ...sets/workflow_wizard_db_configuration.png b/...sets/workflow_wizard_db_configuration.png → ...sets/workflow_wizard_db_configuration.png
diff --git a/.../workflow_wizard_default_baskets_page.png → .../workflow_wizard_default_baskets_page.png b/.../workflow_wizard_default_baskets_page.png → .../workflow_wizard_default_baskets_page.png
diff --git a/docs/assets/workflow_wizard_export_data.png → ...cs/assets/workflow_wizard_export_data.png b/docs/assets/workflow_wizard_export_data.png → ...cs/assets/workflow_wizard_export_data.png
diff --git a/...assets/workflow_wizard_ili2db_options.png → ...assets/workflow_wizard_ili2db_options.png b/...assets/workflow_wizard_ili2db_options.png → ...assets/workflow_wizard_ili2db_options.png
diff --git a/docs/assets/workflow_wizard_intro.png → docs/docs/assets/workflow_wizard_intro.png b/docs/assets/workflow_wizard_intro.png → docs/docs/assets/workflow_wizard_intro.png
diff --git a/...ts/workflow_wizard_project_generation.png → ...ts/workflow_wizard_project_generation.png b/...ts/workflow_wizard_project_generation.png → ...ts/workflow_wizard_project_generation.png
diff --git a/.../assets/workflow_wizard_schema_import.png → .../assets/workflow_wizard_schema_import.png b/.../assets/workflow_wizard_schema_import.png → .../assets/workflow_wizard_schema_import.png
diff --git a/...assets/workflow_wizard_schema_session.png → ...assets/workflow_wizard_schema_session.png b/...assets/workflow_wizard_schema_session.png → ...assets/workflow_wizard_schema_session.png
diff --git a/...sets/workflow_wizard_source_selection.png → ...sets/workflow_wizard_source_selection.png b/...sets/workflow_wizard_source_selection.png → ...sets/workflow_wizard_source_selection.png
diff --git a/...ts/workflow_wizard_tid_generator_page.png → ...ts/workflow_wizard_tid_generator_page.png b/...ts/workflow_wizard_tid_generator_page.png → ...ts/workflow_wizard_tid_generator_page.png
diff --git a/docs/background_info/basket_handling.md → docs/docs/background_info/basket_handling.md b/docs/background_info/basket_handling.md → docs/docs/background_info/basket_handling.md
diff --git a/docs/background_info/catalogues.md → docs/docs/background_info/catalogues.md b/docs/background_info/catalogues.md → docs/docs/background_info/catalogues.md
diff --git a/...ound_info/extended_models_optimization.md → ...ound_info/extended_models_optimization.md b/...ound_info/extended_models_optimization.md → ...ound_info/extended_models_optimization.md
diff --git a/docs/background_info/meta_attributes.md → docs/docs/background_info/meta_attributes.md b/docs/background_info/meta_attributes.md → docs/docs/background_info/meta_attributes.md
diff --git a/docs/background_info/oid_tid_generator.md → ...docs/background_info/oid_tid_generator.md b/docs/background_info/oid_tid_generator.md → ...docs/background_info/oid_tid_generator.md
diff --git a/docs/background_info/repositories.md → docs/docs/background_info/repositories.md b/docs/background_info/repositories.md → docs/docs/background_info/repositories.md
diff --git a/docs/background_info/upgrade_3_to_4.md → docs/docs/background_info/upgrade_3_to_4.md b/docs/background_info/upgrade_3_to_4.md → docs/docs/background_info/upgrade_3_to_4.md
diff --git a/...fo/usabilityhub/modelbaker_integration.md → ...fo/usabilityhub/modelbaker_integration.md b/...fo/usabilityhub/modelbaker_integration.md → ...fo/usabilityhub/modelbaker_integration.md
diff --git a/...nd_info/usabilityhub/technical_concept.md → ...nd_info/usabilityhub/technical_concept.md b/...nd_info/usabilityhub/technical_concept.md → ...nd_info/usabilityhub/technical_concept.md
diff --git a/...ackground_info/usabilityhub/user_guide.md → ...ackground_info/usabilityhub/user_guide.md b/...ackground_info/usabilityhub/user_guide.md → ...ackground_info/usabilityhub/user_guide.md
diff --git a/docs/development.md → docs/docs/development.md b/docs/development.md → docs/docs/development.md
diff --git a/docs/index.de.md → docs/docs/index.de.md b/docs/index.de.md → docs/docs/index.de.md
diff --git a/docs/index.md → docs/docs/index.md b/docs/index.md → docs/docs/index.md
diff --git a/docs/user_guide/export_workflow.md → docs/docs/user_guide/export_workflow.md b/docs/user_guide/export_workflow.md → docs/docs/user_guide/export_workflow.md
diff --git a/docs/user_guide/get_started.md → docs/docs/user_guide/get_started.md b/docs/user_guide/get_started.md → docs/docs/user_guide/get_started.md
@@ -14,7 +14,7 @@ After the installation you can find all the Features in the *Database > Model Ba
 The wizard contains all the functionalities to create database schemas from INTERLIS models, import / export transferdata and generate QGIS projects from the database. It leads you through the process with all the possiblities you have with the single dialogs. Find a guide through the [import and generate process with the wizard](../import_workflow/) and through the [export process with the wizard](../export_workflow/) in this documentation.
 
 ### Data Validator
-The Data Validator provides you the possiblity to check the data currently open in your QGIS against an INTERLIS model. You can open the validator panel as well over *View > Panels > Model Baker Data Validator*. See for more information about it [Validate Data](../user_guide/validation.md)
+The Data Validator provides you the possiblity to check the data currently open in your QGIS against an INTERLIS model. You can open the validator panel as well over *View > Panels > Model Baker Data Validator*. See for more information about it [Validate Data]()
 
 ### Dataset Manager
 The dataset manager provides you the possiblity to create and rename datasets and generate the baskets for the datasets. More information you can find in the [Dataset and Basket Handling](../background_info/basket_handling.md)

diff --git a/docs/user_guide/import_workflow.md → docs/docs/user_guide/import_workflow.md b/docs/user_guide/import_workflow.md → docs/docs/user_guide/import_workflow.md
diff --git a/docs/user_guide/plugin_configuration.md → docs/docs/user_guide/plugin_configuration.md b/docs/user_guide/plugin_configuration.md → docs/docs/user_guide/plugin_configuration.md
diff --git a/docs/user_guide/validation.md → docs/docs/user_guide/validation.md b/docs/user_guide/validation.md → docs/docs/user_guide/validation.md
diff --git a/mkdocs.yml → docs/mkdocs.yml b/mkdocs.yml → docs/mkdocs.yml
@@ -1,9 +1,11 @@
 # Project information
-site_name: QGIS Model Baker Documenation
+site_name: QGIS Model Baker Documentation
 site_description: >-
   This site contains documentation about QGIS Model Baker
 site_url: https://opengisch.github.io/QgisModelBaker/
 
+docs_dir: docs
+
 # Repository
 repo_name: opengisch/QgisModelBaker
 repo_url: https://github.com/opengisch/QgisModelBaker
@@ -12,7 +14,7 @@ edit_uri: https://github.com/opengisch/QgisModelBaker/tree/master/docs/
 # Theme configuration
 theme:
   name: material
-  custom_dir: docs/theme_overrides/
+  custom_dir: theme_overrides/
   features:
     - navigation.tabs
     - navigation.tabs.sticky
@@ -65,25 +67,29 @@ markdown_extensions:
 
 plugins:
   - i18n:
-      default_language: en
       languages:
-        en: English
-        de: Deutsch
-      nav_translations:
-        de:
-          User Guide: Benutzerhandbuch
-          Get Started: Loslegen
-          Model and Data Import Workflow: Modell und Daten Import Workflow
-          Export Data Workflow: Daten Export Workflow
-          Validate Data: Daten Validierung
-          Plugin Configuration: Plugin Konfiguration
-          Repositories: Repositories
-          Basket and Dataset Handling: Dataset und Basket Handling
-          OID Generator: OID Generator
-          Optimized Projects for Extended Models : Optimierte Projekte für erweiterte Modelle
-          Model Baker Integration: Model Baker Integration
-          Technical Concept: Technisches Konzept
-          Catalogues and their special cases: Kataloge und ihre Spezialfälle
-          Meta Attributes: Metaattribute
-          Migrate from ili2db 3 to 4: Migration von ili2db 3 zu 4
-          Development: Enwicklung
+        - locale: en
+          default: true
+          name: English
+          site_name: QGIS Model Baker Documentation
+
+        - locale: de
+          name: Deutsch
+          site_name: QGIS Model Baker Dokumentation
+          nav_translations:
+            User Guide: Benutzerhandbuch
+            Get Started: Loslegen
+            Model and Data Import Workflow: Modell und Daten Import Workflow
+            Export Data Workflow: Daten Export Workflow
+            Validate Data: Daten Validierung
+            Plugin Configuration: Plugin Konfiguration
+            Repositories: Repositories
+            Basket and Dataset Handling: Dataset und Basket Handling
+            OID Generator: OID Generator
+            Optimized Projects for Extended Models : Optimierte Projekte für erweiterte Modelle
+            Model Baker Integration: Model Baker Integration
+            Technical Concept: Technisches Konzept
+            Catalogues and their special cases: Kataloge und ihre Spezialfälle
+            Meta Attributes: Metaattribute
+            Migrate from ili2db 3 to 4: Migration von ili2db 3 zu 4
+            Development: Enwicklung
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1,3 @@
+mkdocs-material==9.5.9
+mkdocs-static-i18n==1.2.0
+python-slugify
diff --git a/docs/.utils/transifex_utils.py → docs/scripts/transifex_utils.py b/docs/.utils/transifex_utils.py → docs/scripts/transifex_utils.py
@@ -1,3 +1,5 @@
+#!/usr/bin/env python
+
 import glob
 import os
 
@@ -16,15 +18,15 @@ def create_transifex_config():
     print("Start creating transifex configuration")
 
     current_dir = os.path.dirname(os.path.abspath(__file__))
-    config_file = os.path.join(current_dir, "..", "..", ".tx", "config")
-    root = os.path.join(current_dir, "..", "..")
+    config_file = os.path.join(current_dir, "..", ".tx", "config")
+    root = os.path.join(current_dir, "..")
     count = 0
 
     with open(config_file, "w") as f:
         f.write("[main]\n")
         f.write("host = https://www.transifex.com\n\n")
 
-        for file in glob.iglob(current_dir + "/../**/*.md", recursive=True):
+        for file in glob.iglob(current_dir + "/../docs/**/*.md", recursive=True):
             # Get relative path of file
             relative_path = os.path.relpath(file, start=root)