Skip to content

Release after quick-start #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 32 commits into from
Dec 6, 2021
Merged

Release after quick-start #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
d8ceca9
First work on writing new generation of docs.
mostlyAtNight Nov 4, 2021
9c81af1
change local path on android after scoped storage (#17)
tomasMizera Nov 8, 2021
1934177
Added tutorials on opening data on your computer and making the first…
mostlyAtNight Nov 12, 2021
8e9f7d8
Merge branch 'dev' of github.com:MerginMaps/docs into dev
mostlyAtNight Nov 12, 2021
de9c654
Updated howto on installing qgis.
mostlyAtNight Nov 15, 2021
94c4e0e
Added section on using Input specifically.
mostlyAtNight Nov 22, 2021
b51ac26
Added collaborative working section of tutorial.
mostlyAtNight Nov 22, 2021
67f56a1
- Pushing getting started tutorials to an advanced state
mostlyAtNight Nov 24, 2021
838b6b2
Put content of to-review folder into howto folder.
mostlyAtNight Nov 26, 2021
ad9dc85
Updated redirects.
mostlyAtNight Nov 26, 2021
6c48756
Added some dead links to test 404 script.
mostlyAtNight Nov 29, 2021
5fcea5a
Various link fixes.
mostlyAtNight Nov 29, 2021
bdfe078
More link fixes
mostlyAtNight Nov 29, 2021
ff26bcf
More link fixes.
mostlyAtNight Nov 29, 2021
1cbbdfa
Tidied up root page (added list of content and removed link to youtub…
mostlyAtNight Nov 29, 2021
ee4c03f
fix #24 fixed broken image troubleshoot (#25)
alex-cit Dec 1, 2021
a96fec7
fix broken image
PeterPetrik Dec 1, 2021
7e1c6a6
Add support for GTM, add testing gtm event
varmar05 Dec 3, 2021
de33cad
Add missing redirects from old docs site
varmar05 Dec 3, 2021
0c0f766
Merge pull request #27 from MerginMaps/fix_redirects
mostlyAtNight Dec 6, 2021
9b24823
Fixes to GTM support
varmar05 Dec 6, 2021
49af7be
Merge pull request #26 from MerginMaps/add_gtm
mostlyAtNight Dec 6, 2021
ea9c03d
Merge branch 'main' into rebase_main
PeterPetrik Dec 6, 2021
511bb11
move files to fix build
PeterPetrik Dec 6, 2021
76da977
Merge pull request #28 from MerginMaps/rebase_main
PeterPetrik Dec 6, 2021
1b01daa
only one link in community/join
PeterPetrik Dec 6, 2021
3340ea1
Fixes for 404s
mostlyAtNight Dec 6, 2021
d7431ca
Merge branch 'dev' of github.com:MerginMaps/docs into dev
mostlyAtNight Dec 6, 2021
c88ad67
do not allow concurent builds
PeterPetrik Dec 6, 2021
097c263
Merge branch 'dev' of github.com:MerginMaps/docs into dev
PeterPetrik Dec 6, 2021
19a9623
test kill
PeterPetrik Dec 6, 2021
306570d
test kill2
PeterPetrik Dec 6, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
name: Build DIST
on: push
concurrency:
group: dist-${{ github.head_ref }}
cancel-in-progress: true
jobs:
generate:
runs-on: ubuntu-latest
Expand Down
53 changes: 51 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ yarn install
yarn dev
```

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).

## Static generation (for deployments)

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

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

## Images
## Images


### Preparation

* Any image prepared should have an associated .xcf file containing the original, full resoluion image
* 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.
* Consistent buttons / toolbars in QGIS
* Windows, not linux
* Making dialogs as small as possible without scrollbars or other bad visuals
* Highlighting
* New layer, black, called Black with 66% opacity
* Tightly select what you want to highlight
* Grow selection by:
* Desktop: 3px
* Mobile: 24px
* Delete hole from Black layer
* Add a layer called Red, transparent, 100% opacity
* Stroke the selection with red, at width:
* Desktop: 3px
* Mobile: 12px



### Referencing

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

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

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

### FIXME: Document how search indexes all H tags

### Reference Mergin project

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

All other code in this repository is licensed under a [MIT license](LICENSE-CODE).

# PROBLEMS

* Anchors don't work
* elements in anchors don't show
* elements also don't work in TOC

# Other things to document

* Not suing mergin maps keyword in URL - it's already in domain name

# Naming things

* We can use vue components references names, allowing us to change them quickly in the future
* This doesn't work for things like url component names and anchor links
* In these situations:

* Filenames:
* mergin-maps-mobile
* Titles
* Mergin Maps Input
95 changes: 95 additions & 0 deletions REDIRECTS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Original page New page
============= ========

https://help.cloudmergin.com/ https://merginmaps.com/docs/
https://help.cloudmergin.com/dashboard https://merginmaps.com/docs/concepts/home-page-and-dashboard/
https://help.cloudmergin.com/developers https://merginmaps.com/docs/howto/integration
https://help.cloudmergin.com/developers.html N/A - covered by non-html version
https://help.cloudmergin.com/faq https://merginmaps.com/docs/
https://help.cloudmergin.com/faq.html N/A - covered by non-html version
https://help.cloudmergin.com/mergin-web https://merginmaps.com/docs/
https://help.cloudmergin.com/permissions https://merginmaps.com/docs/concepts/permissions
https://help.cloudmergin.com/plugin-clone-project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
https://help.cloudmergin.com/plugin-delete-project https://merginmaps.com/docs/howto/manage/plugin/plugin-delete-project
https://help.cloudmergin.com/plugin-download-project https://merginmaps.com/docs/howto/manage/plugin/plugin-sync-project
https://help.cloudmergin.com/plugin-installation https://merginmaps.com/docs/howto/manage/plugin/install
https://help.cloudmergin.com/plugin-logs https://merginmaps.com/docs/howto/manage/troubleshoot
https://help.cloudmergin.com/plugin-new-project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
https://help.cloudmergin.com/plugin-sync-project https://merginmaps.com/docs/howto/manage/plugin/plugin-sync-project
https://help.cloudmergin.com/plugin-variables https://merginmaps.com/docs/howto/manage/plugin/plugin-variables
https://help.cloudmergin.com/project-advanced https://merginmaps.com/docs/howto/manage/web/project-advanced
https://help.cloudmergin.com/project-details https://merginmaps.com/docs/howto/manage/web/project-details
https://help.cloudmergin.com/quick-start https://merginmaps.com/docs/tutorials/capturing-first-data/
https://help.cloudmergin.com/quick-start.html N/A - covered by non-html version
https://help.cloudmergin.com/registration https://merginmaps.com/docs/howto/manage/web/register
https://help.cloudmergin.com/registration.html N/A - covered by non-html version
https://help.cloudmergin.com/sharing-project https://merginmaps.com/docs/howto/manage/web/project-advanced
https://help.cloudmergin.com/subscriptions https://merginmaps.com/docs/howto/manage/web/subscriptions
https://help.cloudmergin.com/support https://merginmaps.com/docs/howto/manage/troubleshoot
https://help.cloudmergin.com/tutorials/data-sync https://merginmaps.com/docs/howto/mergin-tour/
https://help.cloudmergin.com/tutorials/data-sync.html N/A - covered by non-html version
https://help.cloudmergin.com/tutorials/data-transfer https://merginmaps.com/docs/howto/mergin-tour/
https://help.cloudmergin.com/tutorials/data-transfer.html N/A - covered by non-html version
https://help.cloudmergin.com/tutorials/qgis-new-project https://merginmaps.com/docs/howto/mergin-tour/
https://help.cloudmergin.com/tutorials/qgis-new-project.html N/A - covered by non-html version
https://help.cloudmergin.com/tutorials/using-input https://merginmaps.com/docs/howto/mergin-tour/
https://help.cloudmergin.com/tutorials/using-input.html N/A - covered by non-html version
https://help.cloudmergin.com/web-create-project https://merginmaps.com/docs/howto/manage/web/web-create-project
https://help.cloudmergin.com/working-with-organisations https://merginmaps.com/docs/howto/manage/web/working-with-organisations
https://help.cloudmergin.com/working-with-qgis-plugin https://merginmaps.com/docs/
https://help.cloudmergin.com/working-with-qgis-plugin.html N/A - covered by non-html version
https://help.inputapp.io https://merginmaps.com/docs/
https://help.inputapp.io/ https://merginmaps.com/docs/
https://help.inputapp.io/developers https://merginmaps.com/docs/howto/customapp/
https://help.inputapp.io/developers.html N/A - covered by non-html version
https://help.inputapp.io/faq https://merginmaps.com/docs/
https://help.inputapp.io/howto/data_sync https://merginmaps.com/docs/howto/data_sync
https://help.inputapp.io/howto/datum_shift https://merginmaps.com/docs/concepts/projections/
https://help.inputapp.io/howto/enable_browsing https://merginmaps.com/docs/howto/project/enable_browsing
https://help.inputapp.io/howto/enable_digitizing https://merginmaps.com/docs/howto/project/enable_digitizing
https://help.inputapp.io/howto/exif_metadata https://merginmaps.com/docs/howto/exif_metadata
https://help.inputapp.io/howto/external_gps https://merginmaps.com/docs/howto/external_gps
https://help.inputapp.io/howto/package_qgis_project https://merginmaps.com/docs/howto/manage/plugin/plugin-new-project
https://help.inputapp.io/howto/position_variables https://merginmaps.com/docs/howto/position_variables
https://help.inputapp.io/howto/proj https://merginmaps.com/docs/howto/proj/
https://help.inputapp.io/howto/project_config https://merginmaps.com/docs/howto/project/features
https://help.inputapp.io/howto/registration https://merginmaps.com/docs/howto/input_features
https://help.inputapp.io/howto/reuse_entered_values https://merginmaps.com/docs/howto/reuse_last_values
https://help.inputapp.io/howto/search_data https://merginmaps.com/docs/howto/project/search_data
https://help.inputapp.io/howto/search_data.html N/A - covered by non-html version
https://help.inputapp.io/howto/selective_sync https://merginmaps.com/docs/howto/project/selective_sync
https://help.inputapp.io/howto/selective_sync#get-started N/A See redirect for URL without #
https://help.inputapp.io/howto/settingup_background_map https://merginmaps.com/docs/howto/project/settingup_background_map
https://help.inputapp.io/howto/settingup_background_map_rastertile https://merginmaps.com/docs/howto/project/settingup_background_map
https://help.inputapp.io/howto/settingup_background_map_vectortile https://merginmaps.com/docs/howto/project/settingup_background_map
https://help.inputapp.io/howto/settingup_forms https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_cascade https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_checkbox https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_constraints https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_datetime https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_defaults https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_layout https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_number https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_one-to-many https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_photos https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_qrcode https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_slider https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_text https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_valuemap https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/settingup_forms_valuerelation https://merginmaps.com/docs/howto/project/settingup_forms
https://help.inputapp.io/howto/setup_themes https://merginmaps.com/docs/howto/project/setup_themes
https://help.inputapp.io/howto/working_with_nonspatial_data https://merginmaps.com/docs/howto/project/working_with_nonspatial_data
https://help.inputapp.io/input_ui https://merginmaps.com/docs/howto/input_ui
https://help.inputapp.io/licensing https://merginmaps.com/docs/reference/licensing
https://help.inputapp.io/privacy https://merginmaps.com/docs/reference/privacy
https://help.inputapp.io/quick-start https://merginmaps.com/docs/tutorials/capturing-first-data/
https://help.inputapp.io/quick-start.html N/A - covered by non-html version
https://help.inputapp.io/quick-start/create-project https://merginmaps.com/docs/tutorials/capturing-first-data/
https://help.inputapp.io/quick-start/put-project-on-device https://merginmaps.com/docs/tutorials/capturing-first-data/
https://help.inputapp.io/quick-start/share-project https://merginmaps.com/docs/tutorials/working-collaboratively/
https://help.inputapp.io/quick-start/sync-changes https://merginmaps.com/docs/tutorials/opening-surveyed-data-on-your-computer/
https://help.inputapp.io/quick-start/take-the-tour https://merginmaps.com/docs/tutorials/capturing-first-data/
https://help.inputapp.io/resources/mergin-config.json https://merginmaps.com/docs/howto/project/selective_sync/mergin-config.json
https://help.inputapp.io/resources/mergin-config.zip https://merginmaps.com/docs/howto/project/selective_sync/mergin-config.zip
https://help.inputapp.io/support https://merginmaps.com/docs/howto/manage/troubleshoot
https://help.inputapp.io/using_input https://merginmaps.com/docs/howto/input_features
Loading