Skip to content

Commit

Permalink
some minor edits
Browse files Browse the repository at this point in the history
  • Loading branch information
Tony Worm committed May 27, 2024
1 parent e0c5be0 commit 8386a99
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
12 changes: 8 additions & 4 deletions docs/content/getting-started/hof-attributes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ weight: 70
---

{{<lead>}}
The `#hof` definition is how generators, datamodels, and workflows are discovered.
The `#hof` definition is how generators, datamodels, and workflows are discovered and configured.
Several attributes allow you to write shorthand for common settings.
{{</lead>}}

Expand All @@ -20,9 +20,13 @@ Hof turns these CUE attributes into `#hof` configuration.
- `@datamodel(<name>)` - the root of a datamodel
- `@flow(<name>)` - the root of a workflow

Datamodels and workflows have a few more attributes
that can be used under their root.
They are covered in the respective sections on each.
Datamodels and workflows have attributes that can be used under their root
and are covered in their respective sections.

Other attributes:

- `@userfiles(<glob>)` - load file contents into a struct as strings, the key is the filepath.
This works with CUE based commands.

### Schema

Expand Down
4 changes: 4 additions & 0 deletions docs/content/getting-started/task-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ Wrapping the workflow in an API server.

{{<codePane title="server.cue" file="code/getting-started/task-engine/server.html" >}}

<br>

We now have a workflow we can call from the CLI or as an API.

### Command

{{<codeInner title="hof flow help">}}
Expand Down

0 comments on commit 8386a99

Please sign in to comment.