diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml index dd2546f1..d1ef9378 100644 --- a/.github/workflows/docs-ci.yml +++ b/.github/workflows/docs-ci.yml @@ -1,29 +1,33 @@ name: Build documentation run-name: Building static documentation website after push by ${{ github.actor }} on: + workflow_dispatch : ~ push: branches: - - master + - doc-zensical permissions: - contents: write + contents: read + pages: write + id-token: write jobs: deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} runs-on: ubuntu-latest steps: - - uses: actions/checkout@v4 - - name: Configure Git Credentials - run: | - git config user.name github-actions[bot] - git config user.email 41898282+github-actions[bot]@users.noreply.github.com + - uses: actions/configure-pages@v5 + - uses: actions/checkout@v5 - uses: actions/setup-python@v5 with: python-version: 3.x - - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV - - uses: actions/cache@v4 + - run: pip install zensical + - run: zensical build --clean + + + - uses: actions/upload-pages-artifact@v4 with: - key: mkdocs-material-${{ env.cache_id }} - path: .cache - restore-keys: | - mkdocs-material- - - run: pip install mkdocs-material mkdocs-exclude-search - - run: mkdocs gh-deploy --force \ No newline at end of file + path: site + - uses: actions/deploy-pages@v4 + + id: deployment diff --git a/.gitignore b/.gitignore index b671453e..99b3bc06 100644 --- a/.gitignore +++ b/.gitignore @@ -14,4 +14,5 @@ CLAUDE.md INTEGRATION_TESTS_PLAN.md .claude/ .venv/ +site/ .smarttomcat/ diff --git a/README.md b/README.md index dd0757b8..07dcd228 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Extract est modulable et extensible, à installer dans l’environnement informa ## 📋Documentation -Toute la documentation pour installer, paramétrer et utiliser Extract est en ligne (en anglais) : https://asit-asso.github.io/extract/ +Toute la documentation pour installer, paramétrer et utiliser Extract est en ligne (en anglais) : https://benoitregamey.github.io/extract/ ## Groupe utilisateurs diff --git a/docs/mitigations/WP1. Add a timeout (5s) to the getOrder method of the easySDI connector.md b/changelog/v2.2/WP1. Add a timeout (5s) to the getOrder method of the easySDI connector.md similarity index 100% rename from docs/mitigations/WP1. Add a timeout (5s) to the getOrder method of the easySDI connector.md rename to changelog/v2.2/WP1. Add a timeout (5s) to the getOrder method of the easySDI connector.md diff --git a/docs/mitigations/WP2. Customize the User-Agent of the easySDIv4 connector.md b/changelog/v2.2/WP2. Customize the User-Agent of the easySDIv4 connector.md similarity index 100% rename from docs/mitigations/WP2. Customize the User-Agent of the easySDIv4 connector.md rename to changelog/v2.2/WP2. Customize the User-Agent of the easySDIv4 connector.md diff --git a/docs/mitigations/WP3. Mitigations/M1. Extraction of information to a vault or external configuration.md b/changelog/v2.2/WP3. Mitigations/M1. Extraction of information to a vault or external configuration.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/M1. Extraction of information to a vault or external configuration.md rename to changelog/v2.2/WP3. Mitigations/M1. Extraction of information to a vault or external configuration.md diff --git a/docs/mitigations/WP3. Mitigations/M2. Fix command line for FME launch.md b/changelog/v2.2/WP3. Mitigations/M2. Fix command line for FME launch.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/M2. Fix command line for FME launch.md rename to changelog/v2.2/WP3. Mitigations/M2. Fix command line for FME launch.md diff --git a/docs/mitigations/WP3. Mitigations/M3. XML parser configuration corrected to mitigate XXE risk.md b/changelog/v2.2/WP3. Mitigations/M3. XML parser configuration corrected to mitigate XXE risk.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/M3. XML parser configuration corrected to mitigate XXE risk.md rename to changelog/v2.2/WP3. Mitigations/M3. XML parser configuration corrected to mitigate XXE risk.md diff --git a/docs/mitigations/WP3. Mitigations/M4. XML parser configuration corrected to prevent Xpath injections.md b/changelog/v2.2/WP3. Mitigations/M4. XML parser configuration corrected to prevent Xpath injections.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/M4. XML parser configuration corrected to prevent Xpath injections.md rename to changelog/v2.2/WP3. Mitigations/M4. XML parser configuration corrected to prevent Xpath injections.md diff --git a/docs/mitigations/WP3. Mitigations/M5. Download configuration corrected to mitigate risk of SSRF attack.md b/changelog/v2.2/WP3. Mitigations/M5. Download configuration corrected to mitigate risk of SSRF attack.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/M5. Download configuration corrected to mitigate risk of SSRF attack.md rename to changelog/v2.2/WP3. Mitigations/M5. Download configuration corrected to mitigate risk of SSRF attack.md diff --git a/docs/mitigations/WP3. Mitigations/Workpackage.md b/changelog/v2.2/WP3. Mitigations/Workpackage.md similarity index 100% rename from docs/mitigations/WP3. Mitigations/Workpackage.md rename to changelog/v2.2/WP3. Mitigations/Workpackage.md diff --git a/docs/mitigations/WP5. Implementing the todos/Classes/PasswordValidator.md b/changelog/v2.2/WP5. Implementing the todos/Classes/PasswordValidator.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/Classes/PasswordValidator.md rename to changelog/v2.2/WP5. Implementing the todos/Classes/PasswordValidator.md diff --git a/docs/mitigations/WP5. Implementing the todos/T1. Remove user operator.md b/changelog/v2.2/WP5. Implementing the todos/T1. Remove user operator.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T1. Remove user operator.md rename to changelog/v2.2/WP5. Implementing the todos/T1. Remove user operator.md diff --git a/docs/mitigations/WP5. Implementing the todos/T2. Validation of LDAP parameters.md b/changelog/v2.2/WP5. Implementing the todos/T2. Validation of LDAP parameters.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T2. Validation of LDAP parameters.md rename to changelog/v2.2/WP5. Implementing the todos/T2. Validation of LDAP parameters.md diff --git a/docs/mitigations/WP5. Implementing the todos/T3. Modify LDAP user synchronization.md b/changelog/v2.2/WP5. Implementing the todos/T3. Modify LDAP user synchronization.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T3. Modify LDAP user synchronization.md rename to changelog/v2.2/WP5. Implementing the todos/T3. Modify LDAP user synchronization.md diff --git a/docs/mitigations/WP5. Implementing the todos/T4. Notify admins if synchronization is still launched.md b/changelog/v2.2/WP5. Implementing the todos/T4. Notify admins if synchronization is still launched.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T4. Notify admins if synchronization is still launched.md rename to changelog/v2.2/WP5. Implementing the todos/T4. Notify admins if synchronization is still launched.md diff --git a/docs/mitigations/WP5. Implementing the todos/T5. Centralize the password management.md b/changelog/v2.2/WP5. Implementing the todos/T5. Centralize the password management.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T5. Centralize the password management.md rename to changelog/v2.2/WP5. Implementing the todos/T5. Centralize the password management.md diff --git a/docs/mitigations/WP5. Implementing the todos/T6. Centralize the task history management.md b/changelog/v2.2/WP5. Implementing the todos/T6. Centralize the task history management.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T6. Centralize the task history management.md rename to changelog/v2.2/WP5. Implementing the todos/T6. Centralize the task history management.md diff --git a/docs/mitigations/WP5. Implementing the todos/T7. Improving error handling in the TwoFactorController.md b/changelog/v2.2/WP5. Implementing the todos/T7. Improving error handling in the TwoFactorController.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/T7. Improving error handling in the TwoFactorController.md rename to changelog/v2.2/WP5. Implementing the todos/T7. Improving error handling in the TwoFactorController.md diff --git a/docs/mitigations/WP5. Implementing the todos/Workpackage.md b/changelog/v2.2/WP5. Implementing the todos/Workpackage.md similarity index 100% rename from docs/mitigations/WP5. Implementing the todos/Workpackage.md rename to changelog/v2.2/WP5. Implementing the todos/Workpackage.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Annotations/FieldsValueMatch.md b/changelog/v2.2/WP6. Administration page/Classes/Annotations/FieldsValueMatch.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Annotations/FieldsValueMatch.md rename to changelog/v2.2/WP6. Administration page/Classes/Annotations/FieldsValueMatch.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Annotations/PasswordPolicy.md b/changelog/v2.2/WP6. Administration page/Classes/Annotations/PasswordPolicy.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Annotations/PasswordPolicy.md rename to changelog/v2.2/WP6. Administration page/Classes/Annotations/PasswordPolicy.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Annotations/ReservedWords.md b/changelog/v2.2/WP6. Administration page/Classes/Annotations/ReservedWords.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Annotations/ReservedWords.md rename to changelog/v2.2/WP6. Administration page/Classes/Annotations/ReservedWords.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Controllers/SetupController.md b/changelog/v2.2/WP6. Administration page/Classes/Controllers/SetupController.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Controllers/SetupController.md rename to changelog/v2.2/WP6. Administration page/Classes/Controllers/SetupController.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Filters/SetupRedirectFilter.md b/changelog/v2.2/WP6. Administration page/Classes/Filters/SetupRedirectFilter.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Filters/SetupRedirectFilter.md rename to changelog/v2.2/WP6. Administration page/Classes/Filters/SetupRedirectFilter.md diff --git a/docs/mitigations/WP6. Administration page/Classes/Services/AppInitializationService.md b/changelog/v2.2/WP6. Administration page/Classes/Services/AppInitializationService.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Classes/Services/AppInitializationService.md rename to changelog/v2.2/WP6. Administration page/Classes/Services/AppInitializationService.md diff --git a/docs/mitigations/WP6. Administration page/How it works.md b/changelog/v2.2/WP6. Administration page/How it works.md similarity index 100% rename from docs/mitigations/WP6. Administration page/How it works.md rename to changelog/v2.2/WP6. Administration page/How it works.md diff --git a/docs/mitigations/WP6. Administration page/Security.md b/changelog/v2.2/WP6. Administration page/Security.md similarity index 100% rename from docs/mitigations/WP6. Administration page/Security.md rename to changelog/v2.2/WP6. Administration page/Security.md diff --git a/docs/changelog/v2.3/CHANGES.md b/changelog/v2.3/CHANGES.md similarity index 100% rename from docs/changelog/v2.3/CHANGES.md rename to changelog/v2.3/CHANGES.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_308.md b/changelog/v2.3/PATCH_ISSUE_308.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_308.md rename to changelog/v2.3/PATCH_ISSUE_308.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_321.md b/changelog/v2.3/PATCH_ISSUE_321.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_321.md rename to changelog/v2.3/PATCH_ISSUE_321.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_323.md b/changelog/v2.3/PATCH_ISSUE_323.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_323.md rename to changelog/v2.3/PATCH_ISSUE_323.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_333.md b/changelog/v2.3/PATCH_ISSUE_333.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_333.md rename to changelog/v2.3/PATCH_ISSUE_333.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_337.md b/changelog/v2.3/PATCH_ISSUE_337.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_337.md rename to changelog/v2.3/PATCH_ISSUE_337.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_344.md b/changelog/v2.3/PATCH_ISSUE_344.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_344.md rename to changelog/v2.3/PATCH_ISSUE_344.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_346.md b/changelog/v2.3/PATCH_ISSUE_346.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_346.md rename to changelog/v2.3/PATCH_ISSUE_346.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_347.md b/changelog/v2.3/PATCH_ISSUE_347.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_347.md rename to changelog/v2.3/PATCH_ISSUE_347.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_351.md b/changelog/v2.3/PATCH_ISSUE_351.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_351.md rename to changelog/v2.3/PATCH_ISSUE_351.md diff --git a/docs/changelog/v2.3/PATCH_ISSUE_353.md b/changelog/v2.3/PATCH_ISSUE_353.md similarity index 100% rename from docs/changelog/v2.3/PATCH_ISSUE_353.md rename to changelog/v2.3/PATCH_ISSUE_353.md diff --git a/docs/assets/asit_extract_blanc.png b/docs/assets/asit_extract_blanc.png deleted file mode 100644 index 97914d7d..00000000 Binary files a/docs/assets/asit_extract_blanc.png and /dev/null differ diff --git a/docs/assets/asit_extract_couleur.jpg b/docs/assets/asit_extract_couleur.jpg new file mode 100644 index 00000000..74bf0c4e Binary files /dev/null and b/docs/assets/asit_extract_couleur.jpg differ diff --git a/docs/extract-connector-sample/README.md b/docs/extract-connector-sample/README.md index 8fd914fa..7deaa20f 100644 --- a/docs/extract-connector-sample/README.md +++ b/docs/extract-connector-sample/README.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Extract - Initialize a New Connector Plugin ## Introduction diff --git a/docs/extract-task-sample/README.md b/docs/extract-task-sample/README.md index 4afa0475..716b55df 100644 --- a/docs/extract-task-sample/README.md +++ b/docs/extract-task-sample/README.md @@ -1,3 +1,8 @@ +--- +search: + exclude: true +--- + # Extract - Initialize a New Task Plugin ## Introduction diff --git a/docs/features/admin-guide.md b/docs/features/admin-guide.md index b56d3e9c..5e3f85fb 100644 --- a/docs/features/admin-guide.md +++ b/docs/features/admin-guide.md @@ -195,7 +195,7 @@ Following rule parameters are available: * A lower value makes tasks more responsive but increases server resource usage. * It also represents the maximum delay before connector setting changes take effect. * This setting does not affect request imports frequency, which are controlled in each connector’s properties (see [Connector parameters](#connector-parameters)). -* **Request list update frequency** : Defines how often (in seconds) the home page data is refreshed (see [Requests list](../user-guide#requests-list)) +* **Request list update frequency** : Defines how often (in seconds) the home page data is refreshed (see [Requests list](./user-guide#requests-list)) * **Interval between validation reminders** : Specifies the number of days between two email reminders sent to operators when a request is still pending validation. Set this value to 0 to disable reminders. ### Operating hours @@ -253,7 +253,7 @@ The ``Tester la connexion`` button lets you verify whether the current settings ### Request validation ![Validation](../assets/admin-guide/validation.png){width="500"} -This section lets you specify which request properties should be highlighted for operators in the request validation area (see [Validation in the user guide](../user-guide#validation)). No syntax checks is applied to the properties entered here — only properties that actually exists in the request will be considered. +This section lets you specify which request properties should be highlighted for operators in the request validation area (see [Validation in the user guide](./user-guide#validation)). No syntax checks is applied to the properties entered here — only properties that actually exists in the request will be considered. Additionally, this section provides access (by clicking on the `Gérer les modèles` button) to the management of predefined comment templates used during request validation steps. diff --git a/docs/features/development.md b/docs/features/development.md index 7e1c4bdb..9f540856 100644 --- a/docs/features/development.md +++ b/docs/features/development.md @@ -68,16 +68,16 @@ If you would like to set up a local development environment to edit the current 2. Install the necessary packages ```powershell - pip install mkdocs-material mkdocs-exclude-search + pip install zensical ``` 3. Build and serve the documentation on localhost ``` - mkdocs serve + zensical serve ``` 4. Visit http://localhost:8000 -You can then edit the markdown files under ``./docs`` following the syntax from [mkdocs-material](https://squidfunk.github.io/mkdocs-material/reference/){target="_blank"}. The browser will automatically reload when changes are made to the ``./docs`` folder. +You can then edit the markdown files under ``./docs`` following the syntax from [Zensical](https://zensical.org/){target="_blank"}. The browser will automatically reload when changes are made to the ``./docs`` folder. To publish your modification, send them (only the markdown files) through a pull request on GitHub. When your pull request will be merged to the main branch, the documentation will automatically be build and publish to the documentation website. diff --git a/docs/features/image.png b/docs/features/image.png deleted file mode 100644 index 96901430..00000000 Binary files a/docs/features/image.png and /dev/null differ diff --git a/docs/features/user-guide.md b/docs/features/user-guide.md index f313aa04..beedbfef 100644 --- a/docs/features/user-guide.md +++ b/docs/features/user-guide.md @@ -1,13 +1,11 @@ - - ## Login ![Login](../assets/user-guide/login.png){width="500"} Access to the application is secured and requires authentication via either: -* A user account created by the administrator (see [User Administration](./admin-guide.md/#user-administration)), or -+ An account linked to the corporate LDAP directory (see [LDAP authentication](./admin-guide.md/#ldap-authentication)). +* A user account created by the administrator (see [User Administration](./admin-guide.md#user-administration)), or ++ An account linked to the corporate LDAP directory (see [LDAP authentication](./admin-guide.md#ldap-authentication)). Usernames are **not** case-sensitive, but passwords **are** case-sensitive. @@ -115,7 +113,7 @@ The home page provides a real-time overview of the application's activity, inclu **Administrators** can view all requests. **Regular users** only see requests associated with processes where they are assigned as operators. -The page updates automatically based on the refresh interval defined in the application settings (see [Orchestration Section](./admin-guide.md/#orchestration)). By default, this interval is set to 20 seconds. +The page updates automatically based on the refresh interval defined in the application settings (see [Orchestration Section](./admin-guide.md#orchestration)). By default, this interval is set to 20 seconds. ### Status of active connectors @@ -128,7 +126,7 @@ In the top-right corner of the page, chips show active connectors grouped by the If no connectors fall under a particular status, the corresponding chip is not shown. For operators, only error messages may be visible. -Clicking on a chip opens a dropdown listing the relevant connectors. Hovering over a connector displays a tooltip with the time of the last import and any associated error message. Administrators can click a connector to view and edit its settings (see [Connectors detail](./admin-guide.md/#connectors)). +Clicking on a chip opens a dropdown listing the relevant connectors. Hovering over a connector displays a tooltip with the time of the last import and any associated error message. Administrators can click a connector to view and edit its settings (see [Connectors detail](./admin-guide.md#connectors)). ### Requests in progress diff --git a/docs/getting-started/configure.md b/docs/getting-started/configure.md index 11eb6d76..bd4dfc17 100644 --- a/docs/getting-started/configure.md +++ b/docs/getting-started/configure.md @@ -84,6 +84,10 @@ JDBC database connection string. **spring.datasource.username**
Database login username +!!! Warning + The user must have read, write and object creation/deletion privileges on the database, the used schema and all their tables and sequences. If the user belongs to a group, those privileges can ge granted at the group level. + + **spring.servlet.multipart.max-file-size**
Maximum size of each file that can be uploaded to the application. If you receive a 500 error when adding a large file to a request folder, it may be useful to increase this value, remembering to also increase ``spring.servlet.multipart.max-request-size`` if necessary. diff --git a/docs/getting-started/install.md b/docs/getting-started/install.md index ef949ee0..802a0cd4 100644 --- a/docs/getting-started/install.md +++ b/docs/getting-started/install.md @@ -34,7 +34,7 @@ It is normal for any automatic start-up of the application after deployment to f * `extract.i18n.language=de` Extract is in german * `extract.i18n.language=fr,de` Extract is in french and german, french being the default language - To add a new language, please refer to [Add a new language section](../customize/#add-a-new-language). + To add a new language, please refer to [Add a new language section](./customize/#add-a-new-language). 7. Enter the application URL using the `application.external.url` property. The value of this property is used to generate links in notification e-mails. 8. Enter a random 32-character ISO-8859-1 string for `database.encryption.secret` and `database.encryption.salt` properties. These strings are used as keys to encrypt certain database values. diff --git a/docs/how-to/fme-flow.md b/docs/how-to/fme-flow.md index ed15ce3d..5a5b5097 100644 --- a/docs/how-to/fme-flow.md +++ b/docs/how-to/fme-flow.md @@ -4,7 +4,7 @@ This tutorial uses the extraction plugin `Extraction FME Flow (Version 2)` which allows unlimited parameters length, thus allowing request with precise geometries like municipalities boundary. -To follow along with this tutorial, download the sample script and data available [here](https://github.com/asit-asso/extraction-samples). Either by cloning the repo : +To follow along with this tutorial, download the sample script and data available [here](https://github.com/asit-asso/extract-samples){target="_blank"}. Either by cloning the repo : ``` git clone https://github.com/asit-asso/extraction-samples.git diff --git a/docs/how-to/fme-form.md b/docs/how-to/fme-form.md index bf3b60ec..4d127fda 100644 --- a/docs/how-to/fme-form.md +++ b/docs/how-to/fme-form.md @@ -4,7 +4,7 @@ This tutorial uses the extraction plugin `FME Form (Version 2)` which allows unlimited parameters length, thus allowing request with precise geometries like municipalities boundary. -To follow along with this tutorial, download the sample script and data available [here](https://github.com/asit-asso/extraction-samples). Either by cloning the repo : +To follow along with this tutorial, download the sample script and data available [here](https://github.com/asit-asso/extract-samples){target="_blank"}. Either by cloning the repo : ``` git clone https://github.com/asit-asso/extraction-samples.git diff --git a/docs/how-to/python.md b/docs/how-to/python.md index 9eea2069..773be8b1 100644 --- a/docs/how-to/python.md +++ b/docs/how-to/python.md @@ -4,7 +4,7 @@ This tutorial uses the extraction plugin `Extraction Python` that allows you to run a custom Python script. A functional Python interpreter for the script (version, dependencies, etc.) must be provided. -To follow along with this tutorial, you can download the sample script and data available [here](https://github.com/asit-asso/extraction-samples). Either by cloning the repo : +To follow along with this tutorial, you can download the sample script and data available [here](https://github.com/asit-asso/extract-samples){target="_blank"}. Either by cloning the repo : ``` git clone https://github.com/asit-asso/extraction-samples.git diff --git a/docs/how-to/qgis-server-atlas.md b/docs/how-to/qgis-server-atlas.md index a8b8f743..5b1d3c86 100644 --- a/docs/how-to/qgis-server-atlas.md +++ b/docs/how-to/qgis-server-atlas.md @@ -6,7 +6,7 @@ The QGIS Atlas tool allows you to use a fixed scale and a fixed layout size by using an additional vector layer containing a grid that will be used to divide your project in multiple files. Hence, when a client request your data, the plugin will intersect the desired perimeter with your grid and print out as many files as needed to cover the request's perimeter. Each file with the fixed layout size and scale. -To follow along with this tutorial, you can download the sample script and data available [here](https://github.com/asit-asso/extraction-samples). Either by cloning the repo : +To follow along with this tutorial, you can download the sample script and data available [here](https://github.com/asit-asso/extract-samples){target="_blank"}. Either by cloning the repo : ``` git clone https://github.com/asit-asso/extraction-samples.git diff --git a/extract/src/main/resources/application.properties b/extract/src/main/resources/application.properties index 1de63618..d7cf0e79 100644 --- a/extract/src/main/resources/application.properties +++ b/extract/src/main/resources/application.properties @@ -30,7 +30,7 @@ logging.config=classpath:logback-spring.xml logging.level.ch.asit_asso.extract.plugins.email=DEBUG logging.level.ch.asit_asso.extract.email=DEBUG -extract.i18n.language=de,fr,en +extract.i18n.language=fr spring.thymeleaf.cache=false spring.thymeleaf.enabled=true diff --git a/extract/src/main/resources/static/lang/de/messages.properties b/extract/src/main/resources/messages_de.properties similarity index 100% rename from extract/src/main/resources/static/lang/de/messages.properties rename to extract/src/main/resources/messages_de.properties diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 5daa5156..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,74 +0,0 @@ -site_name: Extract Documentation -site_url: https://asit-asso.github.io/extract/ -theme: - name: material - palette: - primary: custom - - font: - text: Asap - code: JetBrains Mono - - logo: assets/asit_extract_blanc.png - favicon: assets/extract_favicon64.png - - features: - - navigation.sections - - navigation.tabs - - navigation.tabs.sticky - - search.suggest - - toc.integrate - - navigation.path - - content.code.copy - - icon: - repo: fontawesome/brands/github - -repo_url: https://github.com/asit-asso/extract -repo_name: asit-asso/extract - -markdown_extensions: - - attr_list - - pymdownx.emoji: - emoji_index: !!python/name:material.extensions.emoji.twemoji - emoji_generator: !!python/name:material.extensions.emoji.to_svg - - admonition - - pymdownx.details - - pymdownx.superfences - - tables - - pymdownx.magiclink - -extra_css: - - stylesheets/extra.css - -nav: - - index.md - - Getting Started: - - getting-started/install.md - - getting-started/configure.md - - getting-started/network-integration.md - - getting-started/customize.md - - getting-started/cybersecurity-win.md - - getting-started/cybersecurity-linux.md - - features/user-guide.md - - features/admin-guide.md - - Dev guide: - - features/development.md - - features/architecture.md - - How-To: - - how-to/extract-viageo.md - - how-to/fme-form.md - - how-to/fme-flow.md - - how-to/python.md - - how-to/qgis-server-atlas.md - - Miscellaneous: - - misc/viageo-test.md - -plugins: - - search - - exclude-search: - exclude: - - mitigations/* - - extract-connector-sample/* - - extract-task-sample/* - - changelog/* diff --git a/zensical.toml b/zensical.toml new file mode 100644 index 00000000..702a8c69 --- /dev/null +++ b/zensical.toml @@ -0,0 +1,65 @@ +[project] +site_name = "Extract Documentation" +site_url = "https://asit-asso.github.io/extract/" +docs_dir = "docs" +site_dir = "site" +repo_url = "https://github.com/asit-asso/extract" +repo_name = "asit-asso/extract" +extra_css = ["stylesheets/extra.css"] +nav = [ + "index.md", + {"Getting Started" = [ + "getting-started/install.md", + "getting-started/configure.md", + "getting-started/network-integration.md", + "getting-started/customize.md", + "getting-started/cybersecurity-win.md", + "getting-started/cybersecurity-linux.md" + ]}, + "features/user-guide.md", + "features/admin-guide.md", + {"Dev Guide" = [ + "features/development.md", + "features/architecture.md" + ]}, + {"How-To" = [ + "how-to/extract-viageo.md", + "how-to/fme-form.md", + "how-to/fme-flow.md", + "how-to/python.md", + "how-to/qgis-server-atlas.md" + ]}, + {"Miscellaneous" = [ + "misc/viageo-test.md" + ]} +] + +[project.theme] +font.text = "Asap" +font.code = "JetBrains Mono" +logo = "assets/asit_extract_couleur.jpg" +favicon = "assets/extract_favicon64.png" +features = [ + "navigation.sections", + "navigation.tabs", + "navigation.tabs.sticky", + "toc.integrate", + "navigation.path", + "content.code.copy" +] + +[project.theme.palette] +primary = "custom" + +[project.theme.icon] +repo = "fontawesome/brands/github" + +[project.markdown_extensions.pymdownx.emoji] +emoji_index = "zensical.extensions.emoji.twemoji" +emoji_generator = "zensical.extensions.emoji.to_svg" + +[project.markdown_extensions.attr_list] +[project.markdown_extensions.admonition] +[project.markdown_extensions.pymdownx.details] +[project.markdown_extensions.pymdownx.superfences] +[project.markdown_extensions.tables] \ No newline at end of file