Skip to content

Commit

Permalink
correct docs
Browse files Browse the repository at this point in the history
Signed-off-by: Austin Abro <[email protected]>
  • Loading branch information
AustinAbro321 committed Aug 14, 2024
1 parent ea15966 commit c61aa54
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions site/src/content/docs/ref/dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,17 @@ When successfully installed, the `yaml.schema` line will match the color of the

#### Specifying Zarf's Schema Version

To ensure consistent validation of the Zarf schema version in a `zarf.yaml` file, it can be beneficial to lock it to a specific version. This can be achieved by appending the following statement to the **first line** of any given `zarf.yaml` file:
To ensure consistent validation of the Zarf schema version in a `zarf.yaml` file, it can be beneficial to lock it to a specific version. This can be achieved by appending the following statement to the **first line** of any given `zarf.yaml` file in visual studio code:

```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/zarf-dev/zarf/<VERSION>/schema/src/zarf_package_v1alpha1.schema.json
# yaml-language-server: $schema=https://raw.githubusercontent.com/zarf-dev/zarf/{VERSION}/schema/src/zarf_package_v1alpha1.schema.json
```

In the above example, `<VERSION>` should be replaced with the specific [Zarf release](https://github.com/zarf-dev/zarf/releases).
:::note
The location of the schema file changed in Zarf v0.39.0. To lock into a specific version before v0.39.0 use https://raw.githubusercontent.com/zarf-dev/zarf/{VERSION}/zarf.schema.json
:::

In the above example, `{VERSION}` should be replaced with the specific [Zarf release](https://github.com/zarf-dev/zarf/releases).

![yaml schema](https://user-images.githubusercontent.com/92826525/226490465-1e6a56f7-41c4-45bf-923b-5242fa4ab64e.png)

Expand Down

0 comments on commit c61aa54

Please sign in to comment.