Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added documentation/assets/images/new-project-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/assets/images/new-project-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/assets/images/new-project-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 36 additions & 0 deletions documentation/how-to/project-setup/create-project.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Create new Project from in QField
tx_slug: documentation_how-to_create-project
---

# Create a new project in QField

It is possible to create a simple project to collect notes and tracking yourself while during note taking.
You can choose between several basemaps and turn it into a cloud project if needed.

!!! Workflow

1. Launch the QField Application on your mobile device
2. Select the big plus sign on the right hand side of the landing page.
!![Welcome Screen](../../assets/images/new-project-1.png,400px)

3. A new window will open where you can configure your project to your needs.

You can select the basemap that you want:

- OpenStreetMap
- Dark Gray
- Light Gray
- Blank
- Your custom Basemap via an URL

!![](../../assets/images/new-project-2.png)

4. If you want to add attachments to your note layer, check the checkbox.
5. You can also track yourself by toggling the switch button.
If needed and start the tracking on project launch.
6. If you want to immediately connect to QFieldCloud and turn it into a cloud project, toggle the switch button.
If you choose to cloudify your project you will be asked to login with your QFieldCloud credentials.
Once you are logged in, the project will immediately be synchronized with QFieldCloud.

!![](../../assets/images/new-project-3.png)
10 changes: 10 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ nav:
- how-to/general/settings.md
- how-to/general/projects.md
- Project Setup:
- how-to/project-setup/create-project.md
- how-to/project-setup/attributes-form.md
- how-to/project-setup/relation-reference-widget.md
- how-to/project-setup/storage.md
Expand Down Expand Up @@ -232,6 +233,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Technische Hinweise
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Erfolgsgeschichten
palette:
- scheme: default
Expand Down Expand Up @@ -268,6 +270,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Documentation technique
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Projets témoin
palette:
- scheme: default
Expand Down Expand Up @@ -304,6 +307,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Documentazione tecnica di riferimento
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Storie di successo
palette:
- scheme: default
Expand Down Expand Up @@ -338,6 +342,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: 技術参考情報
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: ケーススタディ
palette:
- scheme: default
Expand Down Expand Up @@ -374,6 +379,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Referência técnica
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Histórias de sucesso
palette:
- scheme: default
Expand Down Expand Up @@ -410,6 +416,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Referencia técnica
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Historias de éxito
palette:
- scheme: default
Expand Down Expand Up @@ -443,6 +450,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: 技术参考
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: 成功案例
palette:
- scheme: default
Expand Down Expand Up @@ -480,6 +488,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Tekniset viitteet
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Success stories
palette:
- scheme: default
Expand Down Expand Up @@ -542,6 +551,7 @@ plugins:
Navigation and Positioning: Navigation and Positioning
Advanced How To's: Advanced How To's
Technical reference: Referință tehnică
Managing Organization on Self-Hosted: Managing Organization on Self-Hosted
Success stories: Success stories
palette:
- scheme: default
Expand Down
3 changes: 3 additions & 0 deletions utils/mkdocs_tx_commit.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,18 @@ if [[ $(git diff --exit-code mkdocs.yml) ]]; then
git config --global user.name "github-actions[bot]"

echo "detected changes in mkdocs.yml"
git stash push -- mkdocs.yml
if [[ ${GITHUB_EVENT_NAME} == "pull_request" ]]; then
# on PR push to the same branch
gh pr checkout $(echo "${GITHUB_REF_NAME}" | cut -d/ -f1)
git stash pop
git add mkdocs.yml
git commit -m "Update mkdocs.yml translation" --no-verify
git push
else
# on push/workflow_dispatch directly push to branch
git checkout ${GITHUB_REF_NAME}
git stash pop
git add mkdocs.yml
git commit -m "Update mkdocs.yml translation" --no-verify
git push -u origin ${GITHUB_REF_NAME}
Expand Down