From 374cd872e9ea0b5918065caa30163a001965abd8 Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Fri, 15 Nov 2024 09:40:02 -0700 Subject: [PATCH] docs: CUE not cue and typo fix in hello holos --- doc/md/tutorial/hello-holos.mdx | 10 +++------- doc/md/tutorial/helm-values.mdx | 4 ++-- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/doc/md/tutorial/hello-holos.mdx b/doc/md/tutorial/hello-holos.mdx index 8b47606a..a5c27125 100644 --- a/doc/md/tutorial/hello-holos.mdx +++ b/doc/md/tutorial/hello-holos.mdx @@ -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. - - ```bash mkdir -p components/podinfo touch components/podinfo/podinfo.cue @@ -140,8 +138,6 @@ HelmChart: #Helm & { } } ``` - - :::important CUE loads all of `*.cue` files in the component directory to define component, @@ -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. @@ -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. @@ -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. diff --git a/doc/md/tutorial/helm-values.mdx b/doc/md/tutorial/helm-values.mdx index 4fd559c6..3e143ee1 100644 --- a/doc/md/tutorial/helm-values.mdx +++ b/doc/md/tutorial/helm-values.mdx @@ -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.