Skip to content

Commit ed7084d

Browse files
authored
Fix broken links check (#616)
* Fix references in supported_formats * Make the checks job run only on branch push
1 parent 0afabe1 commit ed7084d

File tree

5 files changed

+22
-45
lines changed

5 files changed

+22
-45
lines changed

.github/workflows/checks.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
name: Checks
22
# Triggered when code is pushed to any branch in a repository
3-
on: push
3+
on:
4+
push:
5+
branches:
6+
- '**'
47

58
jobs:
69
spellcheck:
@@ -56,6 +59,13 @@ jobs:
5659
run: |
5760
EXCLUDE_LIST=$(cat scripts/broken-link-exceptions.txt)
5861
echo "EXCLUDE_LIST=$EXCLUDE_LIST" >> $GITHUB_ENV
62+
63+
- name: Do not check Github links on dev branches
64+
if: ${{ github.ref_name != 'main' }}
65+
run: |
66+
# Do not check GH on every commit, their rate limits are too small
67+
EXCLUDE_LIST="$EXCLUDE_LIST --exclude=https://github.com/*"
68+
echo "EXCLUDE_LIST=$EXCLUDE_LIST" >> $GITHUB_ENV
5969
6070
- name: Check broken links
6171
uses: ruzickap/action-my-broken-link-checker@v2

.github/workflows/status-dev.yml

Lines changed: 0 additions & 29 deletions
This file was deleted.

.github/workflows/status-prod.yml

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
name: Status PROD
22

3-
# runs at minute 0 of the 2rd,5th,8th and 11th hour
3+
# runs 6:00 AM every day
44
on:
5-
push:
6-
branches:
7-
- main
85
schedule:
9-
- cron: '0 2,5,8,11 * * *'
6+
- cron: '0 6 * * *'
107

118
jobs:
12-
dev_status_check:
9+
status_check:
1310
runs-on: ubuntu-latest
1411
env:
1512
URL: "https://merginmaps.com/docs"
@@ -29,4 +26,4 @@ jobs:
2926
uses: ruzickap/action-my-broken-link-checker@v2
3027
with:
3128
url: ${{ env.URL }}
32-
cmd_params: --buffer-size=8192 --max-connections=10 --color=always --skip-tls-verification --ignore-fragments --timeout=60 ${{ env.EXCLUDE_LIST }}
29+
cmd_params: --buffer-size=8192 --max-connections=10 --rate-limit=1 --color=always --skip-tls-verification --ignore-fragments --timeout=60 ${{ env.EXCLUDE_LIST }}

README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
[![Checks](https://github.com/MerginMaps/docs/actions/workflows/checks.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/checks.yml)
2-
[![Deploy DEV](https://github.com/MerginMaps/docs/actions/workflows/dist-dev.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/dist-dev.yml)
3-
[![Status DEV](https://github.com/MerginMaps/docs/actions/workflows/status-dev.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/status-dev.yml)
41
[![Deploy PROD](https://github.com/MerginMaps/docs/actions/workflows/dist-prod.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/dist-prod.yml)
52
[![Status PROD](https://github.com/MerginMaps/docs/actions/workflows/status-prod.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/status-prod.yml)
3+
[![Deploy DEV](https://github.com/MerginMaps/docs/actions/workflows/dist-dev.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/dist-dev.yml)
4+
[![Checks](https://github.com/MerginMaps/docs/actions/workflows/checks.yml/badge.svg)](https://github.com/MerginMaps/docs/actions/workflows/checks.yml)
65

76
# Mergin Maps Documentation
87

src/gis/supported_formats/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For survey layers used on the field, we strongly recommend GeoPackage, to be abl
2121
There are more formats supported, please see full list of supported [QGIS providers](#full-list-of-supported-qgis-providers) and [OGR drivers](#full-list-of-supported-ogr-drivers)
2222

2323
::: tip
24-
Go to [Behind Data Synchronisation](../manage/synchronisation.md) to read more about how synchronisation works in <MainPlatformNameLink />.
24+
Go to [Behind Data Synchronisation](../../manage/synchronisation/index.md) to read more about how synchronisation works in <MainPlatformNameLink />.
2525
:::
2626

2727
### PostgreSQL/PostGIS
@@ -31,8 +31,8 @@ PostgreSQL connection (username, password, host, port, etc.) can be set up:
3131

3232
To use a *Connection Service File*, you have to:
3333
- create a `pg_service.conf` file as described in <QGISHelp ver="latest" link="user_manual/managing_data_source/opening_data.html#postgresql-service-connection-file" text="QGIS User Manual" /> and test it in QGIS Desktop
34-
- [manually transfer](../manage/missing-data/index.md) the `pg_service.conf` file to <MobileAppName /> data folder. The data folder is shown in the [Diagnostic Log](../misc/troubleshoot/#diagnostic-log-on-mergin-maps-mobile-app)
35-
- restart the <MobileAppNameShort />. Check the [Diagnostic Log](../misc/troubleshoot/#diagnostic-log-on-mergin-maps-mobile-app) to see if the file is found and used after restart.
34+
- [manually transfer](../../manage/missing-data/index.md) the `pg_service.conf` file to <MobileAppName /> data folder. The data folder is shown in the [Diagnostic Log](../../misc/troubleshoot/#diagnostic-log-on-mergin-maps-mobile-app)
35+
- restart the <MobileAppNameShort />. Check the [Diagnostic Log](../../misc/troubleshoot/#diagnostic-log-on-mergin-maps-mobile-app) to see if the file is found and used after restart.
3636

3737
## Raster data on Mergin Maps mobile app
3838

@@ -53,15 +53,15 @@ To use a *Connection Service File*, you have to:
5353
There are plenty of other raster formats we support through GDAL/OGR, please see [the full list](#full-list-of-supported-gdal-drivers)
5454

5555
::: tip
56-
See [our guide](./settingup_background_map.md) for setting up background layers.
56+
See [our guide](../settingup_background_map/index.md) for setting up background layers.
5757
:::
5858

5959
## Vector tiles on Mergin Maps mobile app
6060

6161
We support vector tiles just like QGIS does - in Mapbox Vector Tiles (MVT) format - and stored either in a MBTiles file (for offline use) or through a template URL (for online service) such as `http://example.com/{z}/{x}/{y}.pbf`.
6262

6363
::: tip
64-
See [our guide](./settingup_background_map.md) for setting up background layers.
64+
See [our guide](../settingup_background_map/index.md) for setting up background layers.
6565
:::
6666

6767
## Full list of supported QGIS providers

0 commit comments

Comments
 (0)