Skip to content

Commit

Permalink
Merge pull request #370 from opengisch/projects-language
Browse files Browse the repository at this point in the history
A few linguistic suggested changes + some details
  • Loading branch information
suricactus authored Sep 7, 2023
2 parents 10fe096 + 87243ca commit ec6d755
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions documentation/reference/qfieldcloud/projects.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,22 @@ title: Projects
tx_slug: documentation_reference_qfieldcloud_projects
---

Projects are the main data container within QFieldCloud. Each user can create one or more QFieldCloud projects. Each project contains a single `.qgs`/`.qgz` QGIS project file, the geospatial files - GeoPackages, Shapefiles, TIFs, and additional data such as photos, PDFs etc. All project data files must be within a single QFieldCloud project.
Projects are the main data containers on QFieldCloud. Users can create any number of projects. Projects must contain a single `.qgs`/`.qgz` QGIS file, and may in addition contain any combination of geospatial files -- GeoPackages, Shapefiles, TIFs -- or data files such as photos, PDFs etc. Files cannot be shared between projects.

Each QFieldCloud project has a name and an owner. The owner of a project is a QFieldCloud user or an organization. The owner name and project name must be a unique combination within QFieldCloud, which means a user cannot have two projects with the same name.
QFieldCloud projects have a name and an owner. The owner of a project is a QFieldCloud user or an organization. No two projects can use the same pair <owner_name, project_name>.

Projects can be marked as public or private. Private projects are accessible only by users that are added as project collaborators. The public projects are visible to anyone on QFieldCloud and they can download the project on their QField device.
Projects can be marked as either public or private. Private projects are accessible only to users added to a project as project collaborators. Public projects are visible to, and can be downloaded by, any QFieldCloud user.

## Creating a project

A project can be created in two different ways: either using the QFieldCloud web interface or using QFieldSync in QGIS.

## Files

Files are the skeleton on which QFieldCloud project works. To make a QFieldCloud project alive you need to upload at least a single QGIS project file in the `.qgs` or `.qgz` file format. All geospatial files need to be uploaded with the same relative paths as on your computer. If external SVG or raster symbology is used, you need to upload these files too.
Files are the skeleton on which QFieldCloud project works. To make a QFieldCloud project alive users need to upload at least a single QGIS project file in the `.qgs` or `.qgz` file formats. All geospatial files must be uploaded using the same relative paths as on one's computer. If external SVG or raster symbology is used, users must upload the corresponding files too.

!!! note
QFieldCloud does not support projects stored in a GeoPackage (`.gpkg`) files.
QFieldCloud does not support projects stored in a GeoPackage (`.gpkg`) files (but users can still use GeoPackage files to store datasets for their projects).

A typical file structure of a QGIS file might look something like this:
```
Expand All @@ -39,13 +39,13 @@ project

## File versions

QFieldCloud uses file versioning that allows you to restore to a previous version of the modified files. The files and file versions can be found in in **Files** section of your project. Each subscription plan has different default number of versions stored for each file. Check the qfield.cloud [pricing page for further details](https://qfield.cloud/pricing.html).
QFieldCloud uses file versioning. This allows users to restore to a previous version of any modified file. Files and file versions can be found under the **Files** section of one's projects. Subscriptions plans allow a different number of versions per file. See the qfield.cloud [pricing page for further details](https://qfield.cloud/pricing.html).

### Deleting old file versions

To ensure only relevant file versions are retained or to reduce the amout of storage needed for your account, you can delete obsolete file versions. You can manually delete file versions from the project's **File** section.
To ensure that only relevant file versions are kept, and to reduce the amount of storage needed by accounts, users can delete obsolete file versions. One can manually delete file versions from the project's **File** section.

To delete versions of files in QFieldCloud, follow these steps:
To delete file versions in QFieldCloud, follow these steps:

1. Go to the "Files" section of your project.![Project files](../../assets/images/files_versions_for_deleting.png)
2. Locate the layer for which you want to delete versions.![Layer selected](../../assets/images/files_versions_for_deleting_2.png)
Expand All @@ -57,22 +57,22 @@ To delete versions of files in QFieldCloud, follow these steps:

## Collaborators

A project collaborator is another QFieldCloud user invited to contribute to a project. One project may have multiple collaborators. Collaborators with role **owner** or **admin** can add more users as collaborators. If the project is owned by an organization, you can also add **teams** as collaborators. Read more about [collaborator roles](permissions.md).
A project collaborator is QFieldCloud user invited to contribute to a project. A single project may have multiple collaborators. Collaborators with roles **owner** or **admin** can add more users as collaborators. Projects owned by an organization allow adding **teams** as collaborators. Read more about [collaborator roles](permissions.md).

## Changes

Changes made on vector layers and pushed to QFieldCloud from a QField device will appear here. Each change stores the changed attributes and geometries.
Changes made on vector layers and uploaded to QFieldCloud from a QField device will appear here. A _change_ stores the difference between attributes or geometries before and after the upload.

Changes have one of the three methods:
Changes register which method was used for uploading; it can be one of:

- `create` - a new feature has been created.
- `delete` - an existing feature has been deleted.
- `patch` - an existing feature has been modified.

Features that have been created and later deleted without being pushed to QFieldCloud will never appear in project changes.
Features that have been created and later deleted without being pushed to QFieldCloud do not appear in project changes.

!!! note
Changes on online vector layers (PostGIS, WFS) that does not have "Offline editing" cloud layer action will not generate a change, but will directly modify the original data source.
Changes to online vector layers (PostGIS, WFS) that do not have "Offline editing" cloud layer action do not generate a change, but instead modify the original data source _directly_.

!!! note
Changes to vector layers done in QGIS will not appear here.
Expand All @@ -83,21 +83,21 @@ Read more about [project jobs](jobs.md).

## Secrets

Secrets are settings that are securely stored in encrypted way. Project jobs will automatically have access to their secrets. Once added, a secret can only be removed, but cannot be edited.
Secrets are settings that are securely stored in encrypted way. Project jobs automatically have access to their secrets. Once added, a secret may be removed, but not edited.

There are two types of secrets:

- **Environment variables** - Environment variables will be available to QGIS while your project jobs are running.
- **Environment variables** - Environment variables will be available to QGIS while your project's jobs are running.
- **pgservice connection** - A PostgreSQL/PostGIS connection as defined in the <code>.pg_service.conf</code> configuration file. If you use multiple service definitions, you should add multiple secrets for each of them.

## Settings

Project settings are available only for project owners and collaborators with elevated permissions. From here a user can access some sensitive project settings or unrecoverable actions.
Project settings are available only to project owners and collaborators with "admin" roles. _Settings_ should be handled carefully as users can modify sensitive project settings and perform unrecoverable actions.

- Change the project visibility to public.
- Change the project owner.
- Permanently delete a project.
- etc

!!! warning
The actions taken on the project settings page might lead to data loss!
Actions issued from a project' settings page can lead to data loss!

0 comments on commit ec6d755

Please sign in to comment.