Skip to content

docs: Add details about new API for getting schema #917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cpuguy83 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

docs: Add details about new API for getting schema #917

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions website/docs/editor-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ title: Editor Support
We provide a [JSON schema file](https://github.com/project-dalec/dalec/blob/main/docs/spec.schema.json) to integrate with your editor.
This will help validate your yaml files and provide intellisense for the spec.

Alternatively, the schema can be fetched from the dalec frontend starting with v0.20:

### With an existing spec

```bash
docker buildx build --call dalec.schema -< path/to/spec
```

This loads the version of dalec set in the "syntax" directive of the spec file.

### Without a spec

```bash
# Provide an empty spec to stdin and set the buildkit frontend parser with the `BUILDKIT_SYNTAX` build arg.
docker buildx build --call dalec.schema --build-arg BUILDKIT_SYNTAX=ghcr.io/project-dalec/frontend:latest -<<<'{}'
```

## VSCode

For VSCode you'll need to use a YAML plugin that supports JSON schemas, such as [YAML Support by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml).
Expand Down