Skip to content
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.

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

Documentation: add typical project structure section #280

Merged
merged 1 commit into from
Jun 1, 2023
Merged
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
39 changes: 39 additions & 0 deletions docs/usage/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,49 @@ QDT expects to find this file in the folder of each profile stored in the source
- on a local Git repository
- on a web server through HTTP using a `qdt.json`

## Typical structure of a project with profiles

Given 3 profiles to be deployed: `avdanced`, `beginner` and `readonly`. Here comes a typical organization of folders, subfolers and files into your repository:

```sh
qgis-profiles/
├── .git/
├── LICENSE
├── profiles
│   ├── advanced
│   │   ├── images
│   │   │   ├── profile_advanced.ico
│   │   │   └── splash.png
│   │   ├── profile.json
│   │   └── QGIS
│   │   ├── QGIS3.ini
│   ├── beginner
│   │   ├── images
│   │   │   ├── profile_beginner.ico
│   │   │   └── splash.png
│   │   ├── profile.json
│   │   └── QGIS
│   │   ├── QGIS3.ini
│   │   └── QGISCUSTOMIZATION3.ini
│   └── readonly
│   ├── bookmarks.xml
│   ├── images
│   │   └── profile_readonly.ico
│   ├── profile.json
│      ├── project_default.qgs
│   └── QGIS
│   └── QGIS3.ini
│      └── QGISCUSTOMIZATION3.ini
├── qdt
│   └── scenario.qdt.yml
├── README.md
```

----

## Good practices and recomendations

- if you use a Git repository, store profiles in a subfolder not at the project root and specify the relative path in scenario
- do not store the entire profile folder, but only files that contans something specific to your profile
- keep only the lines of `*.ini` files which are custom to your profile:
- QGIS will fill them automatically if needed
Expand Down