Merge branch 'master' into beanzmo-getstarted-enhancement

beanzmo · web-flow · commit 19e37ea59831 · 2025-04-22T11:59:41.000+02:00
diff --git a/documentation/assets/images/geofencing-settings.png b/documentation/assets/images/geofencing-settings.png
diff --git a/documentation/assets/images/hyperlink_option.png b/documentation/assets/images/hyperlink_option.png
diff --git a/documentation/assets/videos/geofencing-alert.webm b/documentation/assets/videos/geofencing-alert.webm
diff --git a/documentation/get-started/concepts.en.md b/documentation/get-started/concepts.en.md
@@ -25,14 +25,14 @@ Before heading out to the field though, preliminary steps such as layer styling,
 Since QField is a mobile optimized version of the QGIS desktop app, your project will appear and feel identical both in QGIS and QField.
 The rendering engine in QField is the same as the one used in desktop QGIS, ensuring that projects will appear virtually identical in both environments.
 
-Configurations options prepared in QGIS beforehand don't need to be recreated, which is why QField uses the same edit widgets as QGIS desktop does.
+Configuration options prepared in QGIS beforehand don't need to be recreated, which is why QField uses the same edit widgets as QGIS desktop does.
 As a result, projects configured on the desktop should work seamlessly on the mobile app.
 
 These principles have so far informed our development and design of QField, and will continue to do so in the future.
-In the last few years, QField proved to be the fieldworker's best friend and continues to evolve with new features handling an even broader range of needs.
+In the last few years, QField has proved to be the fieldworker's best friend and continues to evolve with new features handling an even broader range of needs.
 
 ## Mode based
 
 QField is built around different *modes*, similar to the *map tools* in the QGIS desktop version.
 The mode defines the nature of the task.
-In QField, users are either *browsing* through data or *digitizing* new stuff.
+In QField, users are either *browsing* through data or *digitizing* new data.
diff --git a/documentation/get-started/contribute.en.md b/documentation/get-started/contribute.en.md
@@ -18,14 +18,14 @@ QField is an open source project. It is free to share, use and modify and it wil
 
 # Development
 
-if you want to get involved in QField development, please refer to the following doumentations:
+If you want to get involved in QField development, please refer to the following documentation:
   - [QField repository](https://github.com/opengisch/QField/blob/master/doc/dev.md) <!-- markdown-link-check-disable-line -->
   - [QFieldCloud repository](https://github.com/opengisch/qfieldcloud) <!-- markdown-link-check-disable-line -->
   - [QFieldSync repository](https://github.com/opengisch/QFieldSync) <!-- markdown-link-check-disable-line -->
 
 # Credits
 
-QField, QFieldCloud and QFieldSync are developped by [OPENGIS.ch](https://www.opengis.ch/) <!-- markdown-link-check-disable-line -->. OPENGIS.ch does [consulting](https://www.opengis.ch/training-consulting/) <!-- markdown-link-check-disable-line -->,
+QField, QFieldCloud and QFieldSync are developed by [OPENGIS.ch](https://www.opengis.ch/) <!-- markdown-link-check-disable-line -->. OPENGIS.ch does [consulting](https://www.opengis.ch/training-consulting/) <!-- markdown-link-check-disable-line -->,
 [development](https://www.opengis.ch/custom-development/) <!-- markdown-link-check-disable-line -->, [training](https://www.opengis.ch/qfield-training/) <!-- markdown-link-check-disable-line --> and [support](https://www.opengis.ch/qgis-support/) <!-- markdown-link-check-disable-line --> for open source software including QField and
 QGIS.
 
diff --git a/documentation/get-started/faq.en.md b/documentation/get-started/faq.en.md
@@ -8,12 +8,12 @@ tx_slug: documentation_get-started_faq
 ??? help "How many versions of a file are stored on QFieldCloud?"
 
     ## How many versions of a file are stored on QFieldCloud?
-    The number of stored file versions are depending on the account type. 3 versions are stored for COMMUNITY account, and 10 for other account types.
+    The number of stored file versions depends on the account type. 3 versions are stored for COMMUNITY account, and 10 for other account types.
 
 ??? help "How can I delete old file versions?"
 
     ## How can I delete old file versions?
-    You can delete old versions of a file, except for the latest version, from QFieldSync or the QfieldCloud web interface. When you remove a version all previous versions are also removed.
+    You can delete old versions of a file, except for the latest version, from QFieldSync or the QFieldCloud web interface. When you remove a version, all previous versions are also removed.
 
 ??? help "Which browsers are supported by QFieldCloud?"
 
diff --git a/documentation/get-started/how-to-contribute-translation.en.md b/documentation/get-started/how-to-contribute-translation.en.md
@@ -16,7 +16,7 @@ Translations for the QField app are managed through the **Transifex** platform.
 
 1. Select a project you want to contribute to.
 2. Select the language you want to contribute to.
-3. Look for languages requiring translation. For these languages, you'll see a "Translate" button. Click on it.
+3. Look for languages that need translation. These will have a "Translate" button next to them. Click on it.
 
 !![](../assets/images/transifex_translation_01.png,850px)
 
@@ -31,7 +31,7 @@ You'll see a "Join Team" link. Click it and wait for approval (you'll receive an
 
 !![](../assets/images/transifex_translation_02.png,850px)
 
-   - Then choose **No**.
+   - Then choose **No** to show only untranslated strings.
 
 !![](../assets/images/transifex_translation_03.png,850px)
 
@@ -61,9 +61,9 @@ You'll see a "Join Team" link. Click it and wait for approval (you'll receive an
 
 ## 6. Synchronization and Testing
 
-- Translations are typically synchronized with the QField app’s master codebase each day.
+- Translations are typically synchronized with the QField app's master codebase each day.
 - To see your translation reflected in the app:
-    - Join the [QField Beta Program](https://play.google.com/apps/testing/ch.opengis.qfield_dev) for early access to new releases with this translations.
+    - Join the [QField Beta Program](https://play.google.com/apps/testing/ch.opengis.qfield_dev)<!-- markdown-link-check-disable-line --> for early access to new releases with these translations.
 
 If your language is not yet available, we will happily add it for you.
-Just open an issue on GitHub repository and tell us which language you would like to translate it to.
+Just open an issue on the GitHub repository and specify which language you would like to translate to.
diff --git a/documentation/get-started/index.en.md b/documentation/get-started/index.en.md
@@ -47,6 +47,7 @@ The following pages will provide the possible options in detail, which can be ad
     Download the latest <a href="https://qfield.org/get_latest/?platform=macos" target="_blank">MacOS
     version</a> (Universal).
 
+
 QField is available for Android and iOS devices and can also be accessed on the Desktop (Windows, macOS and Linux).
 Use QField for optimised data collection outside in any place on earth.
 Its optimized user interface exposes through a an easy-to-use front-end that gets out of the way the full power of [QGIS](https://qgis.org) under the hood.
@@ -56,6 +57,7 @@ Its optimized user interface exposes through a an easy-to-use front-end that get
 [QFieldCloud](https://qfield.cloud) allows you to seamlessly integrate your team's field work.
 It is a cloud-based service and with its unique technology it will allow your team to focus on what's important, making sure you efficiently get the best field data possible.
 
+
 Thanks to the tight integration with QField, your team will be able to start surveying and digitising data in no time.
 
 [Register Now :material-cloud-outline:](https://app.qfield.cloud/accounts/signup/){ .md-button }
diff --git a/documentation/get-started/license.en.md b/documentation/get-started/license.en.md
@@ -8,7 +8,7 @@ tx_slug: documentation_get-started_license
 QField is released under the GNU Public License (GPL) Version 2 or
 above. Developing QField under this license means that you can inspect
 and modify the source code and guarantees that you will always have
-access to a QGIS based field data collection app that is free of cost
+access to a QGIS-based field data collection app that is free of cost
 and can be freely modified.
 
 You can find the source code on [github](https://github.com/opengisch/QField)
diff --git a/documentation/get-started/settings.en.md b/documentation/get-started/settings.en.md
@@ -70,7 +70,7 @@ When switched on, user's saved and currently opened project bookmarks will be di
 ## Use native camera
 
 If disabled, QField will use a minimalist internal camera instead of the camera app on the device.
-Tip: Enable this option and install the open camera app to create geo tagged photos.
+Tip: Disable this option to have geo tagged photos and have access to the [EXIF](../reference/exif.md) variables.
 
 ## Fast editing mode
 
diff --git a/documentation/get-started/tutorials/advanced-setup-qfc.en.md b/documentation/get-started/tutorials/advanced-setup-qfc.en.md
@@ -5,10 +5,6 @@ tx_slug: documentation_get-started_tutorials_advanced-setup-qfc
 
 # Advanced setup guide
 
-!!! note
-    We have a [community discussion platform](https://github.com/opengisch/qfield/discussions) to discuss your questions, doubts and ideas. Do not hesitate to check it out.
-
-
 ## Supported vector providers
 
 Currently, QFieldCloud supports GeoPackage and PostGIS layers for collaborative editing. Other formats supported by QGIS should also work but are not officially supported.
@@ -23,7 +19,7 @@ If you would like to set up relations, it is recommended to add a UUID field on
 
 1. Setup on QGIS desktop:
     1. Create a new project.
-    2. Create a GeoPackage layers, save it in the same folder than the QGIS project.
+    2. Create GeoPackage layers, save it in the same folder than the QGIS project.
     3. Set the GeoPackage to "Offline editing" in the QFieldSync plugin.
     4. Upload the project to QFieldCloud.
 2. Collect data on the device with QField:
@@ -33,14 +29,14 @@ If you would like to set up relations, it is recommended to add a UUID field on
     1. In QFieldSync, download the updated files (the GeoPackage file should have changed).
 
 !!! warning
-    This workflow does not support changing the GeoPackage on the desktop, as being file base, the whole GeoPackage will be replaced. This means that data can only be digitized using QFieldCloud.
+    This workflow does not support changing the GeoPackage on the desktop, as being file-based, the whole GeoPackage will be replaced. This means that data can only be digitized using QFieldCloud.
 
 
 ## PostGIS
 
 Using PostGIS layers is a good choice if you want data from your QField users to be updated directly in your database by QFieldCloud when they sync their work without any further steps.
 
-It requires your database to be publicly accessible and credentials must be saved unencrypted in the QGIS project. Please be aware of the security implications of such requirements, and remember to have backups.
+It requires your database to be publicly accessible, and credentials must be saved unencrypted in the QGIS project. Please be aware of the security implications of such requirements, and remember to have backups.
 
 ### Example workflow (PostGIS)
 
@@ -183,7 +179,7 @@ You will receive notifications for events in which you are not the actor. These
 
 ## Enhance your project with the "Optimized Packager"
 
-We recommend to use the new "Optimized Packager" over the deprecated "QGIS Core Offline Editing" for all your projects. Set the packager under "Packaging Offliner" in the "Settings" tab of your project.
+We recommend using the new "Optimized Packager" over the deprecated "QGIS Core Offline Editing" for all your projects. Set the packager under "Packaging Offliner" in the "Settings" tab of your project.
 
 The "Optimized Packager" supports consolidating filtered layers of same datasource into a single offline layer, respecting distinct symbology but also using less storage. Here is an example to illustrate this feature:
 
@@ -226,9 +222,9 @@ You can modify the default QFieldCloud server QField and QFieldSync connect to:
 4. Enter the details of the desired server in the provided field.
 (Leaving the field empty will connect to the default QFieldCloud server at app.qfield.cloud.)
 
-!![Reveling server in QField Sync](../../assets/images/changing_default_qfieldcloud_server_qfield_sync.png,250px)
+!![Revealing server in QField Sync](../../assets/images/changing_default_qfieldcloud_server_qfield_sync.png,250px)
 
-!![Reveling server in QField](../../assets/images/changing_default_qfieldcloud_server_qfield.png,250px)
+!![Revealing server in QField](../../assets/images/changing_default_qfieldcloud_server_qfield.png,250px)
 
 !!! note
     It's important to note that QFieldSync does not support the same cloud project in multiple QGIS profiles. As a recommendation use a single QGIS profile for your QFieldCloud projects to avoid synchronization issues.
diff --git a/documentation/get-started/tutorials/get-started-qfc.en.md b/documentation/get-started/tutorials/get-started-qfc.en.md
@@ -5,9 +5,6 @@ tx_slug: documentation_get-started_tutorials_get-started-qfc
 ---
 # Getting started guide
 
-!!! note
-    We have a [community discussion platform](https://github.com/opengisch/qfield/discussions) to discuss your questions, doubts and ideas. Do not hesitate to check it out.
-
 ## Get a free [QFieldCloud account](https://app.qfield.cloud/accounts/signup/)
 
 :material-monitor: Desktop preparation
@@ -147,10 +144,10 @@ Select a project to download on your device:
 
 !![Download](../../assets/images/getting_started_download_project.png,250px)
 
-### Synchronise your changes
+### Synchronize your changes
 
 Make a change to your data. Either create a new feature, delete a feature, or modify the geometry or attributes.
-Open the blue cloud button on the top left of the screen:
+Click the blue cloud button on the top left of the screen:
 
 !![Cloud button](../../assets/images/getting_started_blue_button.png,250px)
 
diff --git a/documentation/get-started/tutorials/get-started-qfs.en.md b/documentation/get-started/tutorials/get-started-qfs.en.md
@@ -85,7 +85,7 @@ Properties
 
 2. Set up the attachment default naming, please refer to the [Configurable picture path](../../how-to/pictures.md#configurable-attachment-path)
 
-3. Set up the maximum number of items shown in the relation editor widget
+3. Set up the maximum number of items shown in the relation editor widget.
 
 !![QFieldSync Layer Properties](../../assets/images/qfield-sync-properties.png)
 
@@ -178,7 +178,7 @@ Simply activate the checkbox labeled "Show the packaging options in the toolbar.
 Copy the folder on your device. Open QField, open the project and start
 collecting data.
 
-Make also sure to save the QGIS project using the regular Save As of
+Also make sure to save the QGIS project using the regular Save As of
 QGIS as you'll have to re-open it later when you want to synchronize
 the changes.
 
@@ -200,7 +200,7 @@ Use iTunes' File Sharing function to import into the QField root folder.
 When you want to synchronize what you have collected, re-open the
 project in QGIS (the one you saved with a regular Save As).
 
-Copy the project folder from your device to your computer and use the
+Copy the project folder from your device to your computer, and use the
 **Synchronize from QField** menu to synchronize your changes from the
 protable project to the main project.
 
diff --git a/documentation/how-to/geofencing.en.md b/documentation/how-to/geofencing.en.md
@@ -0,0 +1,32 @@
+---
+title: Geofencing
+tx_slug: documentation_how-to_geofencing
+---
+
+# Geofencing
+
+QField has a built-in geofencing functinality that can alert or inform users when the position provided by their GNSS device enters and/or leaves areas defined through polygon features. Digitizing of new features can also be prohibited when a geofencing alarm is turned on.
+
+## Defining geofenced areas
+:material-monitor: Desktop preparation
+
+Defining geofenced areas on QGIS happens with the help of the QFieldSync plugin. Simply open the project properties dialog and go to the QField panel, where you will find a checkbox to activate geofencing and a number of widgets to configure its behavior.
+
+!![](../assets/images/geofencing-settings.png)
+
+The geofencing areas layer combobox allows you to pick a polygon vector layer from your project file. You can rely on any data provider, including online sources such as postgis databases.
+
+Once a layer is chosen, you can choose between three geofencing behavior:
+- alert users when inside an area, where the polygons from the vector layer act as no-go areas
+- alert users when outside all areas, where the polygons from the vector layer act as safe areas
+- inform users when entering and leaving areas, where polygons from the vector layer act as areas of informed or warned about
+
+Finally, a checkbox allows you to prohibit the digitizing of new features when in geofencing's alert mode is activated by the first two behaviors above. When checked, users will not be able to digitize new features into the currently opened project.
+
+## Geofencing feedback
+
+When QField turns its geofencing alert on, a glowing read circle will appear at the bottom right corner of your device's screen. The visual queue will remain on the screen until the alert is turned off based on your selected behavior. In addition, on devices that supports vibration, a tactile alert will occur alongside a message informing users of which areas has been trespassed into.
+
+![type:video](../assets/videos/geofencing-alert.webm)
+
+If you enabled the digitizing prevention checkbox, you will notice that QField's digitizing toolbar will disappear while in alert mode to clearly inform users of the ongoing prohibition and avoid accidental data entry.
diff --git a/documentation/how-to/index.en.md b/documentation/how-to/index.en.md
@@ -5,20 +5,14 @@ tx_slug: documentation_how-to_index
 
 # How-to guides
 
-QField leverages the power of QGIS to comfortably configure your
-projects. After setting up everything, you can eventually synchronise your
-project and any additional files to your device and immediately get
-down to work.
+QField leverages the power of QGIS to comfortably configure your projects.
+After setting up everything on your desktop, you can eventually synchronise your project and any additional files to your device and immediately get down to work.
 
-Synchronising your projects to your teams' devices, can be done in
-various way. The QFieldSync plugin helps preparing and packaging QGIS
-projects for QField and distributing it to your devices. For a
-seamless integration experience and for managing teams we highly
-suggest using QFieldCloud.
+Synchronising your projects to your teams' devices, can be done in various ways.
+The QFieldSync plugin helps preparing and packaging QGIS projects for QField and distributing it to your devices.
+For a seamless integration experience and for managing teams we highly suggest using QFieldCloud.
 
-QField is built to be very user friendly and intuitive. We suggest
-starting it and opening a demo project to get used to the powerful
-interaction possibilities.
+QField is built to be very user friendly and intuitive.
+We suggest starting it and opening a demo project to get used to the powerful interaction possibilities.
 
-Here you'll find plenty of resources on how to configure and interact
-with QField.
+Here you'll find plenty of resources on how to configure and interact with QField.
diff --git a/documentation/how-to/pg-service.en.md b/documentation/how-to/pg-service.en.md
@@ -30,7 +30,7 @@ Before beginning, ensure that your PostgreSQL database allows connections from Q
 
 ### Setup `pg_service.conf` File
 
-We first need to set up a configuration file. There are many options to organize this, [read more in the PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-pgservice.html) or follow the description below.
+We first need to set up a configuration file. There are many options to organize this, [read more in the PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-pgservice.html)<!-- markdown-link-check-disable-line --> or follow the description below.
 
 1. **Create a Configuration File**:
 
diff --git a/documentation/how-to/pictures.en.md b/documentation/how-to/pictures.en.md
@@ -92,7 +92,7 @@ Information about location and direction of the pictures will therefore be baked
 
 !!! note
     While with older Android versions it was possible to use other apps like the amazing OpenCamera app for taking pictures and preserving EXIF information from there, this is no longer with recent Android versions.
-    If you enable  *Use native Camera* in the *settings* you will not be able to preserve EXIF information.
+    Is recommended to disable  *Use native Camera* in the *settings* to preserve [EXIF](../reference/exif.md) information.
 
 ## Fetching Geotags (EXIF) from the image file into the attribute table
 :material-monitor: Desktop preparation
diff --git a/documentation/reference/qfieldcloud/architecture.en.md b/documentation/reference/qfieldcloud/architecture.en.md
@@ -123,6 +123,8 @@ The data is stored on 4 **[`minio_data`]** volumes, as replication is enforced b
 
 Should be replaced by a proper S3-like Object Storage SaaS provider.
 
+If `minio` is running, please make sure the host's firewall allows port `8009`, required by the `minio` service (or the port configured with the `MINIO_API_PORT` environment variable).
+
 
 #### [`createbuckets`] Create Minio Buckets
 
@@ -155,7 +157,7 @@ Stores dynamically created user PostGIS databases.
 
 #### [`minio_data`]
 
-Stores data for **[`geodb`] GeoDB PostgreSQL**.
+Stores data for the **[`minio`] S3 service**.
 
 
 #### [`postgres_data`]
diff --git a/documentation/success-stories/rwanda-rural-water.en.md b/documentation/success-stories/rwanda-rural-water.en.md
diff --git a/mkdocs.yml b/mkdocs.yml
