Skip to content

Commit

Permalink
docs: CUE not cue and typo fix in hello holos
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffmccune committed Nov 15, 2024
1 parent 8db06dd commit 374cd87
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 9 deletions.
10 changes: 3 additions & 7 deletions doc/md/tutorial/hello-holos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,6 @@ initialization.
Start by creating a directory for the `podinfo` component. Create an empty file
and then add the following CUE configuration to it.

<Tabs groupId="tutorial-hello-podinfo-helm-cue-code">
<TabItem value="components/podinfo/podinfo.cue" label="Podinfo Helm Chart">
```bash
mkdir -p components/podinfo
touch components/podinfo/podinfo.cue
Expand Down Expand Up @@ -140,8 +138,6 @@ HelmChart: #Helm & {
}
}
```
</TabItem>
</Tabs>

:::important
CUE loads all of `*.cue` files in the component directory to define component,
Expand All @@ -156,7 +152,7 @@ platform root directory. In this example, `#Helm` on line 6 is defined in

### Integrating the component

Integrate the `podinfo` component into the platform by creating a new cue file
Integrate the `podinfo` component into the platform by creating a new CUE file
in the `platform` directory with the following content.

<Tabs groupId="tutorial-hello-register-podinfo-component">
Expand Down Expand Up @@ -348,7 +344,7 @@ grep -B2 Hello deploy/components/podinfo/podinfo.gen.yaml
## Breaking it down
We run `holos render platform ./platform` because the cue files in the platform
We run `holos render platform ./platform` because the CUE files in the platform
directory export a [Platform] resource to `holos`. The platform directory is
the entrypoint to the platform rendering process.

Expand All @@ -358,7 +354,7 @@ file integrates the `podinfo` Component with the Platform.
Holos requires two fields to integrate a component with the platform.

1. A unique name for the component.
2. The component path to the directory containing the cue files exporting a
2. The component path to the directory containing the CUE files exporting a
`BuildPlan` defining the component.

Component parameters are optional. They allow re-use of the same component.
Expand Down
4 changes: 2 additions & 2 deletions doc/md/tutorial/helm-values.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,8 @@ holos cue import \
components/blackbox/vendor/9.0.1/prometheus-blackbox-exporter/values.yaml
```

These command convert the YAML data into CUE code and nest the values under the
`Values` field of the `Holos` struct.
These commands convert the YAML data into CUE code and nest the values under the
`Values` field of the `Helm` struct.

:::important
CUE unifies `values.cue` with the other `*.cue` files in the same directory.
Expand Down

0 comments on commit 374cd87

Please sign in to comment.