Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
@@ -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
path: site
- uses: actions/deploy-pages@v4

id: deployment
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,5 @@ CLAUDE.md
INTEGRATION_TESTS_PLAN.md
.claude/
.venv/
site/
.smarttomcat/
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
Binary file removed docs/assets/asit_extract_blanc.png
Binary file not shown.
Binary file added docs/assets/asit_extract_couleur.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/extract-connector-sample/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Extract - Initialize a New Connector Plugin

## Introduction
Expand Down
5 changes: 5 additions & 0 deletions docs/extract-task-sample/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
search:
exclude: true
---

# Extract - Initialize a New Task Plugin

## Introduction
Expand Down
4 changes: 2 additions & 2 deletions docs/features/admin-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions docs/features/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Binary file removed docs/features/image.png
Binary file not shown.
10 changes: 4 additions & 6 deletions docs/features/user-guide.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
4 changes: 4 additions & 0 deletions docs/getting-started/configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@ JDBC database connection string.
**spring.datasource.username**<br>
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**<br>
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.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/fme-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/fme-form.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to/qgis-server-atlas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion extract/src/main/resources/application.properties
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
74 changes: 0 additions & 74 deletions mkdocs.yml

This file was deleted.

65 changes: 65 additions & 0 deletions zensical.toml
Original file line number Diff line number Diff line change
@@ -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]
Loading