Skip to content

Commit 548896b

Browse files
PeterPetrikPeterPetrik
authored
Merge pull request #29 from MerginMaps/dev
Release after quick-start
2 parents 44b1570 + 306570d commit 548896b

File tree

504 files changed

+1550
-13198
lines changed

Some content is hidden

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

504 files changed

+1550
-13198
lines changed

‎.github/workflows/main.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
name: Build DIST
22
on: push
3+
concurrency:
4+
group: dist-${{ github.head_ref }}
5+
cancel-in-progress: true
36
jobs:
47
generate:
58
runs-on: ubuntu-latest

‎README.md‎

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ yarn install
2929
yarn dev
3030
```
3131

32+
If `yarn install` fails with *ERROR: [Errno 2] No such file or directory: 'install'* then [check out this page](stackoverflow.com/questions/46013544/yarn-install-command-error-no-such-file-or-directory-install).
33+
3234
## Static generation (for deployments)
3335

3436
To generate static HTML files, run
@@ -74,10 +76,34 @@ type is one of "tip"|"warning"|"error", see [vuepress docs](https://v1.vuepress.
7476

7577
```<Badge text="beta" type="warning"/>```
7678

77-
## Images
79+
## Images
80+
81+
82+
### Preparation
83+
84+
* Any image prepared should have an associated .xcf file containing the original, full resoluion image
85+
* Screenshtos of QGIS should be taken with the window sized at 1024x768. [Sizer](http://www.brianapps.net/sizer/#:~:text=Sizer%20is%20a%20freeware%20utility,to%20an%20exact%2C%20predefined%20size.) is good for this task.
86+
* Consistent buttons / toolbars in QGIS
87+
* Windows, not linux
88+
* Making dialogs as small as possible without scrollbars or other bad visuals
89+
* Highlighting
90+
* New layer, black, called Black with 66% opacity
91+
* Tightly select what you want to highlight
92+
* Grow selection by:
93+
* Desktop: 3px
94+
* Mobile: 24px
95+
* Delete hole from Black layer
96+
* Add a layer called Red, transparent, 100% opacity
97+
* Stroke the selection with red, at width:
98+
* Desktop: 3px
99+
* Mobile: 12px
100+
101+
102+
103+
### Referencing
78104

79105
- Do not add `docs` prefix (base)
80-
- Place images next a markdown file that uses it
106+
- Place images next to the markdown files that reference them
81107
- Do not start with `/`, use relative paths
82108

83109
e.g. `![](./cloudmergin.png)` if the image is in the same folder as your mardown file
@@ -115,6 +141,8 @@ Use `<QGISHelp>` component, e.g. `<QGISHelp ver="3.10" link="user_docs/intro.htm
115141

116142
Use `<YouTube>` component, e.g. `<YouTube id="DQXrINUqiFI" />`
117143

144+
### FIXME: Document how search indexes all H tags
145+
118146
### Reference Mergin project
119147

120148
Use `<MerginMapsProject>` component, e.g. `<MerginMapsProject id="lutraconsulting/test_forms" />`
@@ -134,3 +162,24 @@ not yet implemented
134162
The Mergin Maps product documentation in the `docs/content`and `docs/static` are licensed under a [CC-BY license](LICENSE).
135163

136164
All other code in this repository is licensed under a [MIT license](LICENSE-CODE).
165+
166+
# PROBLEMS
167+
168+
* Anchors don't work
169+
* elements in anchors don't show
170+
* elements also don't work in TOC
171+
172+
# Other things to document
173+
174+
* Not suing mergin maps keyword in URL - it's already in domain name
175+
176+
# Naming things
177+
178+
* We can use vue components references names, allowing us to change them quickly in the future
179+
* This doesn't work for things like url component names and anchor links
180+
* In these situations:
181+
182+
* Filenames:
183+
* mergin-maps-mobile
184+
* Titles
185+
* Mergin Maps Input

‎REDIRECTS‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
Original page New page
2+
============= ========
3+
4+
https://help.cloudmergin.com/ https://merginmaps.com/docs/
5+
https://help.cloudmergin.com/dashboard https://merginmaps.com/docs/concepts/home-page-and-dashboard/
6+
https://help.cloudmergin.com/developers https://merginmaps.com/docs/howto/integration
7+
https://help.cloudmergin.com/developers.html N/A - covered by non-html version
8+
https://help.cloudmergin.com/faq https://merginmaps.com/docs/
9+
https://help.cloudmergin.com/faq.html N/A - covered by non-html version
10+
https://help.cloudmergin.com/mergin-web https://merginmaps.com/docs/
11+
https://help.cloudmergin.com/permissions https://merginmaps.com/docs/concepts/permissions
12+
https://help.cloudmergin.com/plugin-clone-project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
13+
https://help.cloudmergin.com/plugin-delete-project https://merginmaps.com/docs/howto/manage/plugin/plugin-delete-project
14+
https://help.cloudmergin.com/plugin-download-project https://merginmaps.com/docs/howto/manage/plugin/plugin-sync-project
15+
https://help.cloudmergin.com/plugin-installation https://merginmaps.com/docs/howto/manage/plugin/install
16+
https://help.cloudmergin.com/plugin-logs https://merginmaps.com/docs/howto/manage/troubleshoot
17+
https://help.cloudmergin.com/plugin-new-project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
18+
https://help.cloudmergin.com/plugin-sync-project https://merginmaps.com/docs/howto/manage/plugin/plugin-sync-project
19+
https://help.cloudmergin.com/plugin-variables https://merginmaps.com/docs/howto/manage/plugin/plugin-variables
20+
https://help.cloudmergin.com/project-advanced https://merginmaps.com/docs/howto/manage/web/project-advanced
21+
https://help.cloudmergin.com/project-details https://merginmaps.com/docs/howto/manage/web/project-details
22+
https://help.cloudmergin.com/quick-start https://merginmaps.com/docs/tutorials/capturing-first-data/
23+
https://help.cloudmergin.com/quick-start.html N/A - covered by non-html version
24+
https://help.cloudmergin.com/registration https://merginmaps.com/docs/howto/manage/web/register
25+
https://help.cloudmergin.com/registration.html N/A - covered by non-html version
26+
https://help.cloudmergin.com/sharing-project https://merginmaps.com/docs/howto/manage/web/project-advanced
27+
https://help.cloudmergin.com/subscriptions https://merginmaps.com/docs/howto/manage/web/subscriptions
28+
https://help.cloudmergin.com/support https://merginmaps.com/docs/howto/manage/troubleshoot
29+
https://help.cloudmergin.com/tutorials/data-sync https://merginmaps.com/docs/howto/mergin-tour/
30+
https://help.cloudmergin.com/tutorials/data-sync.html N/A - covered by non-html version
31+
https://help.cloudmergin.com/tutorials/data-transfer https://merginmaps.com/docs/howto/mergin-tour/
32+
https://help.cloudmergin.com/tutorials/data-transfer.html N/A - covered by non-html version
33+
https://help.cloudmergin.com/tutorials/qgis-new-project https://merginmaps.com/docs/howto/mergin-tour/
34+
https://help.cloudmergin.com/tutorials/qgis-new-project.html N/A - covered by non-html version
35+
https://help.cloudmergin.com/tutorials/using-input https://merginmaps.com/docs/howto/mergin-tour/
36+
https://help.cloudmergin.com/tutorials/using-input.html N/A - covered by non-html version
37+
https://help.cloudmergin.com/web-create-project https://merginmaps.com/docs/howto/manage/web/web-create-project
38+
https://help.cloudmergin.com/working-with-organisations https://merginmaps.com/docs/howto/manage/web/working-with-organisations
39+
https://help.cloudmergin.com/working-with-qgis-plugin https://merginmaps.com/docs/
40+
https://help.cloudmergin.com/working-with-qgis-plugin.html N/A - covered by non-html version
41+
https://help.inputapp.io https://merginmaps.com/docs/
42+
https://help.inputapp.io/ https://merginmaps.com/docs/
43+
https://help.inputapp.io/developers https://merginmaps.com/docs/howto/customapp/
44+
https://help.inputapp.io/developers.html N/A - covered by non-html version
45+
https://help.inputapp.io/faq https://merginmaps.com/docs/
46+
https://help.inputapp.io/howto/data_sync https://merginmaps.com/docs/howto/data_sync
47+
https://help.inputapp.io/howto/datum_shift https://merginmaps.com/docs/concepts/projections/
48+
https://help.inputapp.io/howto/enable_browsing https://merginmaps.com/docs/howto/project/enable_browsing
49+
https://help.inputapp.io/howto/enable_digitizing https://merginmaps.com/docs/howto/project/enable_digitizing
50+
https://help.inputapp.io/howto/exif_metadata https://merginmaps.com/docs/howto/exif_metadata
51+
https://help.inputapp.io/howto/external_gps https://merginmaps.com/docs/howto/external_gps
52+
https://help.inputapp.io/howto/package_qgis_project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
53+
https://help.inputapp.io/howto/position_variables https://merginmaps.com/docs/howto/position_variables
54+
https://help.inputapp.io/howto/proj https://merginmaps.com/docs/howto/proj/
55+
https://help.inputapp.io/howto/project_config https://merginmaps.com/docs/howto/project/features
56+
https://help.inputapp.io/howto/registration https://merginmaps.com/docs/howto/input_features
57+
https://help.inputapp.io/howto/reuse_entered_values https://merginmaps.com/docs/howto/reuse_last_values
58+
https://help.inputapp.io/howto/search_data https://merginmaps.com/docs/howto/project/search_data
59+
https://help.inputapp.io/howto/search_data.html N/A - covered by non-html version
60+
https://help.inputapp.io/howto/selective_sync https://merginmaps.com/docs/howto/project/selective_sync
61+
https://help.inputapp.io/howto/selective_sync#get-started N/A See redirect for URL without #
62+
https://help.inputapp.io/howto/settingup_background_map https://merginmaps.com/docs/howto/project/settingup_background_map
63+
https://help.inputapp.io/howto/settingup_background_map_rastertile https://merginmaps.com/docs/howto/project/settingup_background_map
64+
https://help.inputapp.io/howto/settingup_background_map_vectortile https://merginmaps.com/docs/howto/project/settingup_background_map
65+
https://help.inputapp.io/howto/settingup_forms https://merginmaps.com/docs/howto/project/settingup_forms
66+
https://help.inputapp.io/howto/settingup_forms_cascade https://merginmaps.com/docs/howto/project/settingup_forms
67+
https://help.inputapp.io/howto/settingup_forms_checkbox https://merginmaps.com/docs/howto/project/settingup_forms
68+
https://help.inputapp.io/howto/settingup_forms_constraints https://merginmaps.com/docs/howto/project/settingup_forms
69+
https://help.inputapp.io/howto/settingup_forms_datetime https://merginmaps.com/docs/howto/project/settingup_forms
70+
https://help.inputapp.io/howto/settingup_forms_defaults https://merginmaps.com/docs/howto/project/settingup_forms
71+
https://help.inputapp.io/howto/settingup_forms_layout https://merginmaps.com/docs/howto/project/settingup_forms
72+
https://help.inputapp.io/howto/settingup_forms_number https://merginmaps.com/docs/howto/project/settingup_forms
73+
https://help.inputapp.io/howto/settingup_forms_one-to-many https://merginmaps.com/docs/howto/project/settingup_forms
74+
https://help.inputapp.io/howto/settingup_forms_photos https://merginmaps.com/docs/howto/project/settingup_forms
75+
https://help.inputapp.io/howto/settingup_forms_qrcode https://merginmaps.com/docs/howto/project/settingup_forms
76+
https://help.inputapp.io/howto/settingup_forms_slider https://merginmaps.com/docs/howto/project/settingup_forms
77+
https://help.inputapp.io/howto/settingup_forms_text https://merginmaps.com/docs/howto/project/settingup_forms
78+
https://help.inputapp.io/howto/settingup_forms_valuemap https://merginmaps.com/docs/howto/project/settingup_forms
79+
https://help.inputapp.io/howto/settingup_forms_valuerelation https://merginmaps.com/docs/howto/project/settingup_forms
80+
https://help.inputapp.io/howto/setup_themes https://merginmaps.com/docs/howto/project/setup_themes
81+
https://help.inputapp.io/howto/working_with_nonspatial_data https://merginmaps.com/docs/howto/project/working_with_nonspatial_data
82+
https://help.inputapp.io/input_ui https://merginmaps.com/docs/howto/input_ui
83+
https://help.inputapp.io/licensing https://merginmaps.com/docs/reference/licensing
84+
https://help.inputapp.io/privacy https://merginmaps.com/docs/reference/privacy
85+
https://help.inputapp.io/quick-start https://merginmaps.com/docs/tutorials/capturing-first-data/
86+
https://help.inputapp.io/quick-start.html N/A - covered by non-html version
87+
https://help.inputapp.io/quick-start/create-project https://merginmaps.com/docs/tutorials/capturing-first-data/
88+
https://help.inputapp.io/quick-start/put-project-on-device https://merginmaps.com/docs/tutorials/capturing-first-data/
89+
https://help.inputapp.io/quick-start/share-project https://merginmaps.com/docs/tutorials/working-collaboratively/
90+
https://help.inputapp.io/quick-start/sync-changes https://merginmaps.com/docs/tutorials/opening-surveyed-data-on-your-computer/
91+
https://help.inputapp.io/quick-start/take-the-tour https://merginmaps.com/docs/tutorials/capturing-first-data/
92+
https://help.inputapp.io/resources/mergin-config.json https://merginmaps.com/docs/howto/project/selective_sync/mergin-config.json
93+
https://help.inputapp.io/resources/mergin-config.zip https://merginmaps.com/docs/howto/project/selective_sync/mergin-config.zip
94+
https://help.inputapp.io/support https://merginmaps.com/docs/howto/manage/troubleshoot
95+
https://help.inputapp.io/using_input https://merginmaps.com/docs/howto/input_features

0 commit comments

Comments
 (0)