Skip to content
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.

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

docs/{reference,concept}: using the cue vet command #192

Open
jpluscplusm opened this issue Jan 10, 2025 · 1 comment
Open

docs/{reference,concept}: using the cue vet command #192

jpluscplusm opened this issue Jan 10, 2025 · 1 comment
Assignees

Comments

@jpluscplusm
Copy link
Collaborator

We've established a pattern for pairs of reference and concept guides (linked here for the first command documented: cue export).

Let's expand this set by creating a similar pair of guides for cue vet.

@jpluscplusm
Copy link
Collaborator Author

WIP CL: https://cuelang.org/cl/1207010.

cueckoo pushed a commit to cue-lang/cuelang.org-trybot that referenced this issue Feb 5, 2025
This adds a brief landing page for cue-vet (at
/docs/reference/command/cue-vet/) and links to it from a new card on the
existing /docs/reference/command/ page. It adds a longer concept guide
at /docs/concept/using-the-cue-vet-command/ which describes cue-vet's
two operating modes: "CUE" mode and "data" mode.

It also includes a mention of "cue vet -c" on
/docs/concept/working-with-incomplete-cue/, so that a link to the page
from the cue-vet concept guide to explain "incompleteness" then connects
back (narratively speaking) to the concept guide. A header is added to
the existing guide in order to split it up, as it's now a little too
long just to be one section of prose.

For cue-lang/cue#2120.
Closes cue-lang/docs-and-content#192.

Preview-Path: /docs/reference/command/
Preview-Path: /docs/reference/command/cue-vet/
Preview-Path: /docs/concept/using-the-cue-vet-command/
Preview-Path: /docs/concept/using-the-cue-vet-command/validating-cue/
Preview-Path: /docs/concept/using-the-cue-vet-command/validating-data/
Preview-Path: /docs/concept/working-with-incomplete-cue/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I4ab7af25f838b136f126e41682af9481e0eef15b
Dispatch-Trailer: {"type":"trybot","CL":1207010,"patchset":11,"ref":"refs/changes/10/1207010/11","targetBranch":"master"}
cueckoo pushed a commit to cue-lang/cuelang.org-trybot that referenced this issue Feb 12, 2025
This adds a brief landing page for cue-vet (at
/docs/reference/command/cue-vet/) and links to it from a new card on the
existing /docs/reference/command/ page. It adds a longer concept guide
at /docs/concept/using-the-cue-vet-command/ which describes cue-vet's
two operating modes: "CUE" mode and "data" mode.

It also includes a mention of "cue vet -c" on
/docs/concept/working-with-incomplete-cue/, so that a link to the page
from the cue-vet concept guide to explain "incompleteness" then connects
back (narratively speaking) to the concept guide. A header is added to
the existing guide in order to split it up, as it's now a little too
long just to be one section of prose.

For cue-lang/cue#2120.
Closes cue-lang/docs-and-content#192.

Preview-Path: /docs/reference/command/
Preview-Path: /docs/reference/command/cue-vet/
Preview-Path: /docs/concept/using-the-cue-vet-command/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-cue/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-data/
Preview-Path: /docs/concept/using-the-cue-vet-command/output/
Preview-Path: /docs/concept/working-with-incomplete-cue/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I4ab7af25f838b136f126e41682af9481e0eef15b
Dispatch-Trailer: {"type":"trybot","CL":1207010,"patchset":14,"ref":"refs/changes/10/1207010/14","targetBranch":"master"}
cueckoo pushed a commit to cue-lang/cuelang.org-trybot that referenced this issue Feb 12, 2025
This adds a brief landing page for cue-vet (at
/docs/reference/command/cue-vet/) and links to it from a new card on the
existing /docs/reference/command/ page. It adds a longer concept guide
at /docs/concept/using-the-cue-vet-command/ which describes cue-vet's
two operating modes: "CUE" mode and "data" mode.

It also includes a mention of "cue vet -c" on
/docs/concept/working-with-incomplete-cue/, so that a link to the page
from the cue-vet concept guide to explain "incompleteness" then connects
back (narratively speaking) to the concept guide. A header is added to
the existing guide in order to split it up, as it's now a little too
long just to be one section of prose.

For cue-lang/cue#2120.
Closes cue-lang/docs-and-content#192.

Preview-Path: /docs/reference/command/cue-vet/
Preview-Path: /docs/reference/command/
Preview-Path: /docs/concept/using-the-cue-vet-command/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-cue/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-data/
Preview-Path: /docs/concept/using-the-cue-vet-command/output/
Preview-Path: /docs/concept/working-with-incomplete-cue/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I4ab7af25f838b136f126e41682af9481e0eef15b
Dispatch-Trailer: {"type":"trybot","CL":1207010,"patchset":15,"ref":"refs/changes/10/1207010/15","targetBranch":"master"}
cueckoo pushed a commit to cue-lang/cuelang.org-trybot that referenced this issue Feb 12, 2025
This adds a brief landing page for cue-vet (at
/docs/reference/command/cue-vet/) and links to it from a new card on the
existing /docs/reference/command/ page. It adds a longer concept guide
at /docs/concept/using-the-cue-vet-command/ which describes cue-vet's
two operating modes: "CUE" mode and "data" mode.

It also includes a mention of "cue vet -c" on
/docs/concept/working-with-incomplete-cue/, so that a link to the page
from the cue-vet concept guide to explain "incompleteness" then connects
back (narratively speaking) to the concept guide. A header is added to
the existing guide in order to split it up, as it's now a little too
long just to be one section of prose.

For cue-lang/cue#2120.
Closes cue-lang/docs-and-content#192.

Preview-Path: /docs/reference/command/cue-vet/
Preview-Path: /docs/reference/command/
Preview-Path: /docs/concept/using-the-cue-vet-command/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-cue/
Preview-Path: /docs/concept/using-the-cue-vet-command/validate-data/
Preview-Path: /docs/concept/using-the-cue-vet-command/output/
Preview-Path: /docs/concept/working-with-incomplete-cue/
Signed-off-by: Jonathan Matthews <[email protected]>
Change-Id: I4ab7af25f838b136f126e41682af9481e0eef15b
Dispatch-Trailer: {"type":"trybot","CL":1207010,"patchset":16,"ref":"refs/changes/10/1207010/16","targetBranch":"master"}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

No branches or pull requests

1 participant