Skip to content

Commit 60564a3

Browse files
authored
Merge pull request #395 from MerginMaps/iss_359_new-products-name
Iss #359 new products name (cleanup)
2 parents ab6d387 + 6cfaaac commit 60564a3

File tree

64 files changed

+330
-298
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+330
-298
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<template>
2-
<span class="nospellcheck">Mergin Maps Input</span>
2+
<span class="nospellcheck">Mergin Maps mobile app</span>
33
</template>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<span class="nospellcheck">mobile app</span>
3+
</template>

src/.vuepress/components/QGIS.vue

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<template>
2+
<span>
3+
<a :href="`https://qgis.org/${link}`" target="_blank" rel="noopener noreferrer">
4+
<img alt="QGIS Documentation" :src="$withBase('/QGIS.svg')" />
5+
<span v-html="text"></span>
6+
<span>
7+
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound">
8+
<path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path>
9+
<polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon>
10+
</svg>
11+
<span class="sr-only">(opens new window)</span>
12+
</span>
13+
</a>
14+
</span>
15+
</template>
16+
17+
<script>
18+
export default {
19+
name: "qgishelp",
20+
props: {
21+
ver: String,
22+
link: String,
23+
text: String
24+
}
25+
}
26+
</script>
27+
28+
<style scoped>
29+
img {
30+
border: none;
31+
height: 15px;
32+
}
33+
</style>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
<template>
2-
<span>Mergin Maps plugin for QGIS</span>
2+
<span>Mergin Maps QGIS plugin</span>
33
</template>
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<template>
2+
<span>QGIS plugin</span>
3+
</template>

src/.vuepress/components/SinceBadge.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<template>
22
<span>
3-
<span class="sincebadge" v-if="type === 'App'" >since Mobile {{ version }}</span>
4-
<span class="sincebadge" v-else-if="type === 'Plugin'">since Plugin {{ version }}</span>
3+
<span class="sincebadge" v-if="type === 'App'" >since Mobile app {{ version }}</span>
4+
<span class="sincebadge" v-else-if="type === 'Plugin'">since QGIS plugin {{ version }}</span>
55
<span class="sincebadge" v-else-if="type === 'Server'">since Server {{ version }}</span>
66
</span>
77
</template>

src/dev/ce-migration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ docker-compose -f docker-compose.yml stop
3636
$ git pull
3737
```
3838

39-
6. Set environment variables (<GitHubRepo desc=".prod.env" id="MerginMaps/mergin/blob/master/.prod.env" /> file). **Important** ⚠️
39+
6. Set environment variables (<GitHubRepo desc=".prod.env" id="MerginMaps/server/blob/master/.prod.env" /> file). **Important** ⚠️
4040

4141
As mentioned earlier, CE operates with one global workspace. We will set it up now.
4242
Specify its name with the following environment variable:

src/dev/customapp.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Our mobile app <MobileAppName /> provides seamless synchronisation of field data
44

55
The good news is that <MobileAppName /> is licensed as open source software, which means that anything is possible with a bit of development!
66

7-
If you are interested in building a custom app, you can start by going to <GitHubRepo id="MerginMaps/input"/> repository on GitHub and building it for your platform.
7+
If you are interested in building a custom app, you can start by going to <GitHubRepo id="MerginMaps/mobile"/> repository on GitHub and building it for your platform.
88

9-
The <GitHubRepo id="MerginMaps/input-sdk" desc="Input SDK repository" /> provides all the dependencies for various platforms (Android, iOS, macOS, Windows).
9+
The <GitHubRepo id="MerginMaps/mobile-sdk" desc="mobile app SDK repository" /> provides all the dependencies for various platforms (Android, iOS, macOS, Windows).

src/dev/dbsync.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<YouTube id="4mWcaKs9jkw" />
66

7-
**Interested in using DB Sync?** Go to <GitHubRepo id="MerginMaps/mergin-db-sync" /> repository for the source code and more details. Here, you will also find the Quick start guide that will show you how to set up one way synchronisation between your PostGIS database and a new <MainPlatformName /> project.
7+
**Interested in using DB Sync?** Go to <GitHubRepo id="MerginMaps/db-sync" /> repository for the source code and more details. Here, you will also find the Quick start guide that will show you how to set up one way synchronisation between your PostGIS database and a new <MainPlatformName /> project.
88

99
:::tip Usage details
1010
DB Sync can be used with *Team*, *Academia* and *Non-profit* <MainDomainNameLink id="pricing" desc="subscription plans"/>, as well as in [<CommunityPlatformName />](./mergince/) and [<EnterprisePlatformName />](./merginmaps-ee/).

src/dev/integration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can try these tools for free during the trial period.
1414
## Python client module
1515
The Python client module is the easiest way to programmatically use <MainPlatformNameLink />. You can use Python API or a command-line tool to easily work with <MainPlatformName /> projects, such as to get project status, push and pull changes, or to download, create and delete projects.
1616

17-
The <GitHubRepo id="MerginMaps/mergin-py-client" /> repository contains the source code of the Python client module and more information on how to use it.
17+
The <GitHubRepo id="MerginMaps/python-api-client" /> repository contains the source code of the Python client module and more information on how to use it.
1818

1919
Python client is available in the PyPI repository and can be installed with `pip`:
2020

@@ -45,14 +45,14 @@ For example, to download a <MainPlatformName /> project to a local folder:
4545
```
4646
mergin download john/project1 ~/mergin/project1
4747
```
48-
For more details, visit <GitHubRepo id="MerginMaps/mergin-py-client" />.
48+
For more details, visit <GitHubRepo id="MerginMaps/python-api-client" />.
4949

5050
## C++ standalone client
5151
C++ Client has advantage over Python that it is completely without any dependencies.
5252

53-
To install the C++ client, just download the binary for your platform from <GitHubRepo id="MerginMaps/mergin-cpp-client/releases"/> and use it from the command line.
53+
To install the C++ client, just download the binary for your platform from <GitHubRepo id="MerginMaps/cpp-api-client/releases"/> and use it from the command line.
5454

55-
Go to <GitHubRepo id="MerginMaps/mergin-cpp-client" /> repository for more information on how to use it.
55+
Go to <GitHubRepo id="MerginMaps/cpp-api-client" /> repository for more information on how to use it.
5656

5757
### C++ Command line tool
5858
When the client is installed, it comes with `mergin` command line tool.
@@ -77,4 +77,4 @@ Commands:
7777

7878
### C++ Mergin Maps API core library
7979

80-
Client is based on the Qt-based <GitHubRepo id="MerginMaps/input/tree/master/core" desc="mergin maps api core library" /> used by the <MainDomainNameLink desc="Mergin Maps Input" /> to sync the projects in the mobile application.
80+
Client is based on the Qt-based <GitHubRepo id="MerginMaps/mobile/tree/master/core" desc="Mergin Maps API core library" /> used by the <MainDomainNameLink desc="Mergin Maps mobile app" /> to sync the projects in the mobile application.

src/dev/media-sync/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Media Sync has two sync modes: in copy mode, media files are only copied the ext
77

88
<YouTube id="jAElsCZRBdc" />
99

10-
**Interested in using Media Sync?** Go to <GitHubRepo id="MerginMaps/mergin-media-sync" /> repository for the source code and more details. Here, you will also find the Quick start guide that will show you how to set up one way synchronisation between a new <MainPlatformName /> project and your existing bucket (<NoSpellcheck id="MinIO" /> or S3).
10+
**Interested in using Media Sync?** Go to <GitHubRepo id="MerginMaps/media-sync" /> repository for the source code and more details. Here, you will also find the Quick start guide that will show you how to set up one way synchronisation between a new <MainPlatformName /> project and your existing bucket (<NoSpellcheck id="MinIO" /> or S3).
1111

1212
:::tip Usage details
1313
Media Sync can be used with *Team*, *Academia* and *Non-profit* <MainDomainNameLink id="pricing" desc="subscription plans"/>, as well as in [<CommunityPlatformName />](../mergince/) and [<EnterprisePlatformName />](../merginmaps-ee/).

src/dev/mergince.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
SaaS <MainPlatformName /> service is a web platform for storage and synchronisation of data between mobile devices, <MainPlatformNameLink /> service and QGIS Desktop.
55

6-
There is also <MainPlatformName /> Community Edition (<CommunityPlatformNameLink />) that is licensed as open source software. The source code for <CommunityPlatformName /> can be modified and used for custom deployments. You can contribute your code to <GitHubRepo id="MerginMaps/mergin" />.
6+
There is also <MainPlatformName /> Community Edition (<CommunityPlatformNameLink />) that is licensed as open source software. The source code for <CommunityPlatformName /> can be modified and used for custom deployments. You can contribute your code to <GitHubRepo id="MerginMaps/server" />.
77

88
[How to Use <MainPlatformName /> with a Custom Server](../manage/plugin-multi-server-use/) will explain how to use <QGISPluginName /> and <MobileAppName /> with your <CommunityPlatformName /> server.
99

@@ -14,14 +14,14 @@ Need more functionality than <CommunityPlatformNameLink /> offers? Explore our [
1414
:::
1515

1616
## How to deploy Mergin Maps CE
17-
**Interested in deploying <CommunityPlatformName />?** You can start by going to <GitHubRepo id="MerginMaps/mergin" /> on GitHub and read instructions on how to deploy it for your platform.
17+
**Interested in deploying <CommunityPlatformName />?** You can start by going to <GitHubRepo id="MerginMaps/server" /> on GitHub and read instructions on how to deploy it for your platform.
1818

1919
:::tip
2020
Follow our [Migration Guides](./ce-migration/) to migrate from older versions to the latest version of <CommunityPlatformName />.
2121
:::
2222
2323
### Start docker containers
24-
Provided that `docker` and `docker-compose` are installed on your host, running Mergin Maps stack should be as simple as running `docker-compose`. However, before doing that you would need to [configure](#configure) your server setup via environment variables in <GitHubRepo desc=".prod.env" id="MerginMaps/mergin/blob/master/.prod.env" /> file.
24+
Provided that `docker` and `docker-compose` are installed on your host, running Mergin Maps stack should be as simple as running `docker-compose`. However, before doing that you would need to [configure](#configure) your server setup via environment variables in <GitHubRepo desc=".prod.env" id="MerginMaps/server/blob/master/.prod.env" /> file.
2525

2626
Once configured, you can run:
2727
```shell
@@ -39,7 +39,7 @@ $ docker exec merginmaps-server flask user create <username> <password> --is-adm
3939
```
4040
4141
### Configure
42-
There are several application settings which can be changed via <GitHubRepo desc="config variables" id="MerginMaps/mergin/blob/master/.prod.env" />. Some of them have defaults and some of them needs to be modified, particularly those with `fixme` placeholder (marked with asterisks below).
42+
There are several application settings which can be changed via <GitHubRepo desc="config variables" id="MerginMaps/server/blob/master/.prod.env" />. Some of them have defaults and some of them needs to be modified, particularly those with `fixme` placeholder (marked with asterisks below).
4343
4444
#### Server basics
4545
Settings about your deployment. Variables marked with star ⭐️ need to be modified.

src/dev/work-packages/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The **Work Packages** tool is designed to manage field surveys for multiple team
88

99
The main <MainPlatformNameLink/> project (*Survey*) contains all data. The admin of the main project can assign some of the data to working package projects (*Survey Team A*, *Survey Team B*). The teams can see and modify only the data that are assigned to them.
1010

11-
**Interested in using Work Packages?** Go to <GitHubRepo id="MerginMaps/mergin-work-packages" /> repository for the source code, more details and a quick start with a simple project.
11+
**Interested in using Work Packages?** Go to <GitHubRepo id="MerginMaps/work-packages" /> repository for the source code, more details and a quick start with a simple project.
1212

1313
:::tip Usage details
1414
Work Packages can be used with *Team*, *Academia* and *Non-profit* <MainDomainNameLink id="pricing" desc="subscription plans"/>, as well as in [<CommunityPlatformName />](../mergince/) and [<EnterprisePlatformName />](../merginmaps-ee/).

src/field/autosync/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
# Synchronisation in Mergin Maps Input
2-
<SinceBadge type="App" version="1.4.0" />
1+
# Synchronisation in Mergin Maps Mobile App
32
[[toc]]
43

54
Changes in your project can be synchronised during the survey manually by using the sync button or automatically by allowing the automatic synchronisation in <MobileAppName />.
@@ -11,7 +10,7 @@ To be able to synchronise a project, you need to:
1110

1211
The sync button is displayed in the map window.
1312

14-
![Sync button in Mergin Maps Input](../input-autosync.jpg "Sync button")
13+
![Sync button in Mergin Maps mobile app](../input-autosync.jpg "Sync button")
1514

1615
:::tip
1716
Are you missing some data after synchronisation? [How to Recover Missing Data](../../manage/missing-data/) will show you how to deal with [conflict files](../../manage/missing-data/#there-are-conflict-files-in-the-folder) and how to [manually download](../../manage/missing-data/#there-are-no-conflict-files-in-the-folder) data from your mobile device.

src/field/broken-project/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# How to Fix a Broken Project
2-
<SinceBadge type="App" version="2.0.0" />
32
[[toc]]
43

54
Do you get an error message when trying to open a project in <MobileAppName />? There can be multiple reasons for what went wrong. Here we will try to guide you through some basic steps that can help you.

src/field/external_gps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# External GPS
22

3-
<!--- IMPORTANT: This permalink is referenced from Mergin Maps Input -->
3+
<!--- IMPORTANT: This permalink is referenced from Mergin Maps mobile app -->
44

55
[[toc]]
66

@@ -37,7 +37,7 @@ In Android, there are two ways how to use an external GPS device in <MobileAppNa
3737

3838
It is strongly recommended to use the direct connection in <MobileAppName />. It is easier, quicker, provides more data, such as HDOP and fix quality. The app will report which device is used and take care of reconnecting in case of lost connection. Using mock location should be used only when it is not possible to connect the GPS receiver directly via <MobileAppName />.
3939

40-
### How to connect external GPS receiver in Android via Mergin Maps Input (recommended)
40+
### How to connect external GPS receiver in Android via Mergin Maps mobile app (recommended)
4141
1. Connect the GPS receiver to your mobile device via Bluetooth.
4242
2. Open <MobileAppName /> and navigate **Select GPS receiver** in Settings:
4343
![Select GPS receiver](./input-external-gps.jpg "Select GPS receiver")

src/field/gps_accuracy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Your GPS accuracy depends on several parameters, such as:
55
- View of the clear sky that affects the number of satellites visible from your position
66

77
When doing the survey, it is essential to be aware of the limitations of your GPS accuracy at the time of recording. Current GPS accuracy is displayed above the bottom navigation panel in <MobileAppName />. Also, there is a circle with the size of the accuracy value around the position marker.
8-
![GPS accuracy displayed in Mergin Maps Input](./input-gps2.jpg "GPS accuracy displayed in Mergin Maps Input")
8+
![GPS accuracy displayed in Mergin Maps mobile app](./input-gps2.jpg "GPS accuracy displayed in Mergin Maps mobile app")
99

1010
A warning will appear, if your accuracy is outside the GPS accuracy threshold. To get rid of this warning, you can increase your **Accuracy threshold** or turn off these warnings in [Settings](./input_ui.md#gps-settings).
1111
![Low GPS position accuracy warning](./input-gps-warning.jpg "Low GPS position accuracy warning")

0 commit comments

Comments
 (0)