Skip to content

Commit

Permalink
add files
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 e94ebdc commit 671d161
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions site/src/content/docs/ref/dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tableOfContents:

## Schema Validation

Zarf uses the [Zarf package schema](https://github.com/zarf-dev/zarf/blob/main/schema/src/zarf_package_v1alpha1.schema.json) to define its configuration files. This schema is used to describe package configuration options and enable the validation of configuration files prior to their use in building a Zarf Package.
Zarf uses the [Zarf package schema](https://github.com/zarf-dev/zarf/blob/main/schema/zarf_package_v1alpha1.schema.json) to define its configuration files. This schema is used to describe package configuration options and enable the validation of configuration files prior to their use in building a Zarf Package.

### `zarf dev lint`

Expand All @@ -28,7 +28,7 @@ zarf dev lint <dir>

```json
"yaml.schemas": {
"https://raw.githubusercontent.com/zarf-dev/zarf/main/schema/src/zarf_package_v1alpha1.schema.json": "zarf.yaml"
"https://raw.githubusercontent.com/zarf-dev/zarf/main/schema/zarf_package_v1alpha1.schema.json": "zarf.yaml"
}
```

Expand All @@ -43,7 +43,7 @@ When successfully installed, the `yaml.schema` line will match the color of the
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/zarf_package_v1alpha1.schema.json
```

:::note
Expand Down
4 changes: 2 additions & 2 deletions site/src/content/docs/tutorials/0-creating-a-zarf-package.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ In order to create a Zarf package you first need to have an idea of what applica

### Creating the Package Definition

A `zarf.yaml` file follows the [Zarf Package Schema](https://github.com/zarf-dev/zarf/blob/main/schema/src/zarf_package_v1alpha1.schema.json) and allows us to specify package metadata and a set of components for us to deploy. We start a package definition with the `kind` of package we are making and `metadata` that describes the package. You can start our WordPress package by creating a new `zarf.yaml` with the following content:
A `zarf.yaml` file follows the [Zarf Package Schema](https://github.com/zarf-dev/zarf/blob/main/schema/zarf_package_v1alpha1.schema.json) and allows us to specify package metadata and a set of components for us to deploy. We start a package definition with the `kind` of package we are making and `metadata` that describes the package. You can start our WordPress package by creating a new `zarf.yaml` with the following content:

```yaml
kind: ZarfPackageConfig # ZarfPackageConfig is the package kind for most normal zarf packages
Expand All @@ -40,7 +40,7 @@ metadata:
:::tip
You can run [`zarf dev lint <directory>`](/commands/zarf_dev_lint/) to validate against the [`zarf.schema.json`](https://github.com/zarf-dev/zarf/blob/main/schema/src/zarf_package_v1alpha1.schema.json), or setup [VSCode](/ref/dev/#vscode) to see errors in real-time.
You can run [`zarf dev lint <directory>`](/commands/zarf_dev_lint/) to validate against the [`zarf.schema.json`](https://github.com/zarf-dev/zarf/blob/main/schema/zarf_package_v1alpha1.schema.json), or setup [VSCode](/ref/dev/#vscode) to see errors in real-time.

:::

Expand Down

0 comments on commit 671d161

Please sign in to comment.