From c4245b1abe0d62977b295f2fa77ba8db8499a270 Mon Sep 17 00:00:00 2001 From: Julien Date: Fri, 13 Dec 2024 11:13:32 +0100 Subject: [PATCH] update(docs): fix shcemas JSON URLs --- docs/guides/howto_validate_profiles_scenarios.md | 8 +++++++- examples/scenarios/demo-scenario-http.qdt.yml | 2 +- examples/scenarios/demo-scenario.qdt.yml | 2 +- scenario.qdt.yml | 2 +- .../good_scenario_plugins_downloader_force.qdt.yml | 2 +- tests/fixtures/scenarios/good_scenario_sample.qdt.yml | 2 +- tests/fixtures/scenarios/scenario_sample_as_admin.qdt.yml | 2 +- 7 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/guides/howto_validate_profiles_scenarios.md b/docs/guides/howto_validate_profiles_scenarios.md index 4257e4fc..84b6a449 100644 --- a/docs/guides/howto_validate_profiles_scenarios.md +++ b/docs/guides/howto_validate_profiles_scenarios.md @@ -34,11 +34,17 @@ Add the following line at the top of your JSON file: ```json { "yaml.schemas": { - "https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json": "*.qdt.yml" + "https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json": "*.qdt.yml" } } ``` +Alternatively you can add this line at the top of the file: + +```yaml +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json +``` + ---- ## Using pre-commit diff --git a/examples/scenarios/demo-scenario-http.qdt.yml b/examples/scenarios/demo-scenario-http.qdt.yml index 1de6578c..eb6f7eac 100644 --- a/examples/scenarios/demo-scenario-http.qdt.yml +++ b/examples/scenarios/demo-scenario-http.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json metadata: title: "Demonstration scenario of QGIS Deployment Toolbelt with HTTP" diff --git a/examples/scenarios/demo-scenario.qdt.yml b/examples/scenarios/demo-scenario.qdt.yml index 39cf9ddc..c65a2b29 100644 --- a/examples/scenarios/demo-scenario.qdt.yml +++ b/examples/scenarios/demo-scenario.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json metadata: title: "Demonstration scenario of QGIS Deployment Toolbelt" diff --git a/scenario.qdt.yml b/scenario.qdt.yml index 0e95320a..d85e92c9 100644 --- a/scenario.qdt.yml +++ b/scenario.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json metadata: title: "Demonstration scenario of QGIS Deployment Toolbelt" diff --git a/tests/fixtures/scenarios/good_scenario_plugins_downloader_force.qdt.yml b/tests/fixtures/scenarios/good_scenario_plugins_downloader_force.qdt.yml index 69da5fed..fca161e3 100644 --- a/tests/fixtures/scenarios/good_scenario_plugins_downloader_force.qdt.yml +++ b/tests/fixtures/scenarios/good_scenario_plugins_downloader_force.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json # This is a sample of a YAML file for the QGIS Deployment Toolbelt scenario. # For now, it's more a roadmap than a real description of what it's implemented. diff --git a/tests/fixtures/scenarios/good_scenario_sample.qdt.yml b/tests/fixtures/scenarios/good_scenario_sample.qdt.yml index 5cc9c414..1c9a6270 100644 --- a/tests/fixtures/scenarios/good_scenario_sample.qdt.yml +++ b/tests/fixtures/scenarios/good_scenario_sample.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json # This is a sample of a YAML file for the QGIS Deployment Toolbelt scenario. # For now, it's more a roadmap than a real description of what it's implemented. diff --git a/tests/fixtures/scenarios/scenario_sample_as_admin.qdt.yml b/tests/fixtures/scenarios/scenario_sample_as_admin.qdt.yml index ed889ada..481940c8 100644 --- a/tests/fixtures/scenarios/scenario_sample_as_admin.qdt.yml +++ b/tests/fixtures/scenarios/scenario_sample_as_admin.qdt.yml @@ -1,4 +1,4 @@ -# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/main/docs/schemas/scenario/schema.json +# yaml-language-server: $schema=https://raw.githubusercontent.com/qgis-deployment/qgis-deployment-toolbelt-cli/refs/heads/main/docs/schemas/scenario/qdt_scenario.json # This is a sample of a YAML file for the QGIS Deployment Toolbelt scenario. # For now, it's more a roadmap than a real description of what it's implemented.