Skip to content

Commit e804ed6

Browse files
committed
Achieve profile section
1 parent 0f09faf commit e804ed6

File tree

4 files changed

+28
-14
lines changed

4 files changed

+28
-14
lines changed

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ caption: Miscellaneous
7474
maxdepth: 1
7575
---
7676
misc/compatibility
77+
misc/tip_get_plugin_id
7778
misc/credits
7879
misc/funding
7980
```

docs/misc/tip_get_plugin_id.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# How to get a plugin ID
2+
3+
1. Open the repository in your browser. Example for the official set on QGIS 3.28: <https://plugins.qgis.org/plugins/plugins.xml?qgis=3.28>
4+
1. Open the RAW mode (or source), typing `Ctrl + U` or right-click and select `View page source`
5+
1. Use your browser search `Ctrl + F` to look for the plugin you want
6+
1. Grab the `plugin_id` attribute:
7+
8+
![Plugin ID into official repository - Example QuickOSM](/static/repository_plugins_plugin_id.webp)

docs/usage/how_it_works.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,25 @@
22

33
## Concepts
44

5-
To run the workflow properly, you will need 3 items:
5+
To run the workflow properly, you need 3 items:
66

77
| QGIS profiles | A scenario | The QDT executable |
8-
| -- | -- | -- |
8+
| ------------- | ---------- | ------------------ |
99
| ![icon profiles](/static/icon_profiles.svg) | ![icon scenario](/static/icon_scenario.svg) | ![icon QDT](/static/logo_qdt.png) |
1010

1111
### QGIS profiles
1212

13-
> TO DOC
13+
One of the most interesting aspects of QGIS when it comes to deploying it to a large number of users is the ability to provide them with one or more customised experiences via [the profile system](https://docs.qgis.org/latest/en/docs/user_manual/introduction/qgis_configuration.html). A profile contains many settings: interface items, installed and deactivated plugins, variables, network settings, etc.
14+
15+
To facilitate their management and administration, QDT uses a profile definition file in JSON format (`profile.json` stored in the profile folder) which then serves as a "recipe" at the time of installation and especially when updating a profile.
16+
17+
```{button-link} ./profile.html
18+
:color: primary
19+
:shadow:
20+
:expand:
21+
22+
Publish your QGIS profiles
23+
```
1424

1525
### Scenarios
1626

@@ -60,7 +70,7 @@ flowchart TB
6070
E1[QDT executable + scenario.qdt.yml]
6171
E2{RUN<br>cron / manual double-click}
6272
E3[Read scenario]
63-
E3>Set persistent environment variables]
73+
E4>Set environment variables]
6474
E5>Sync local profiles from repo]
6575
E6>Download and install plugins locally]
6676
E7>Create shortcuts to profiles]

docs/usage/profile.md

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ QDT expects to find this file in the folder of each profile stored in the source
88

99
## Publish them
1010

11-
> TO DO
11+
----
1212

1313
## Good practices and recomendations
1414

@@ -17,15 +17,6 @@ QDT expects to find this file in the folder of each profile stored in the source
1717
- QGIS will fill them automatically if needed
1818
- it reduces the surface of possible conflicts when dealing to upgrade a profile
1919

20-
## How to get a plugin ID
21-
22-
1. Open the repository in your browser. Example for the official set on QGIS 3.28: <https://plugins.qgis.org/plugins/plugins.xml?qgis=3.28>
23-
1. Open the RAW mode (or source), typing `Ctrl + U` or right-click and select `View page source`
24-
1. Use your browser search `Ctrl + F` to look for the plugin you want
25-
1. Grab the `plugin_id` attribute:
26-
27-
![Plugin ID into official repository - Example QuickOSM](/static/repository_plugins_plugin_id.webp)
28-
2920
----
3021

3122
## Model definition
@@ -44,6 +35,10 @@ With a submodel for plugin object:
4435
:language: json
4536
```
4637

38+
:::{tip}
39+
To retrieve the ID of a plugin see [this page](../misc/tip_get_plugin_id.md).
40+
:::
41+
4742
----
4843

4944
## Sample profile.json

0 commit comments

Comments
 (0)