tweaks to hello-world example

xigxog · Feb 1, 2024 · 6ca281a · 6ca281a
1 parent d4e9ca5
commit 6ca281a
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 6 deletions.
diff --git a/docs/reference/fox/fox.md b/docs/reference/fox/fox.md
@@ -28,7 +28,7 @@ and release your KubeFox Apps.
 * [fox docs](fox_docs.md)	 - Generate docs for 🦊 Fox
 * [fox init](fox_init.md)	 - Initialize a KubeFox App
 * [fox proxy](fox_proxy.md)	 - Port forward local port to broker's HTTP server adapter
-* [fox publish](fox_publish.md)	 - Builds, pushes, and deploys KubeFox Apps using the version of the currently checked out Git commit
+* [fox publish](fox_publish.md)	 - Builds, pushes, and deploys KubeFox Apps using the component code from the currently checked out Git commit
 * [fox release](fox_release.md)	 - Release specified AppDeployment and VirtualEnvironment
 * [fox version](fox_version.md)	 - Show version information of 🦊 Fox
 
diff --git a/docs/reference/fox/fox_deploy.md b/docs/reference/fox/fox_deploy.md
@@ -3,7 +3,7 @@
 Deploy KubeFox App using the component code from the currently checked out Git commit
 
 ```
-fox deploy [NAME] [flags]
+fox deploy [flags]
 ```
 
 ### Options
@@ -12,6 +12,7 @@ fox deploy [NAME] [flags]
   -t, --create-tag         create Git tag using the AppDeployment version
       --dry-run            submit server-side request without persisting the resource
   -h, --help               help for deploy
+  -d, --name string        name to use for AppDeployment, defaults to <APP NAME>-<VERSION | GIT REF | GIT COMMIT>
   -n, --namespace string   namespace of KubeFox Platform
   -p, --platform string    name of KubeFox Platform to utilize
   -s, --version string     version to assign to the AppDeployment, making it immutable

diff --git a/docs/reference/fox/fox_publish.md b/docs/reference/fox/fox_publish.md
@@ -1,9 +1,9 @@
 ## fox publish
 
-Builds, pushes, and deploys KubeFox Apps using the version of the currently checked out Git commit
+Builds, pushes, and deploys KubeFox Apps using the component code from the currently checked out Git commit
 
 ```
-fox publish [NAME] [flags]
+fox publish [flags]
 ```
 
 ### Options
@@ -14,6 +14,7 @@ fox publish [NAME] [flags]
       --force              force build even if component image exists
   -h, --help               help for publish
   -k, --kind string        if provided the built image will be loaded into the kind cluster
+  -d, --name string        name to use for AppDeployment, defaults to <APP NAME>-<VERSION | GIT REF | GIT COMMIT>
   -n, --namespace string   namespace of KubeFox Platform
       --no-cache           do not use cache when building image
   -p, --platform string    name of KubeFox Platform to utilize

diff --git a/examples/go/hello-world/kubefox/app.yaml b/examples/go/hello-world/kubefox/app.yaml
@@ -1,3 +1,3 @@
 name: hello-world
 title: Hello World
-description: A simple app demonstrating the use of KubeFox.
+description: A simple App demonstrating the use of KubeFox.
diff --git a/examples/go/hello-world/kubefox/hack/environments/prod.yaml b/examples/go/hello-world/kubefox/hack/environments/prod.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: kubefox.xigxog.io/v1alpha1
 kind: Environment
 metadata:
@@ -7,8 +8,8 @@ spec:
     type: Stable
 data:
   vars:
-    subPath: prod
     who: Universe
+    subPath: prod
 ---
 apiVersion: kubefox.xigxog.io/v1alpha1
 kind: VirtualEnvironment

diff --git a/examples/go/hello-world/kubefox/hack/environments/qa.yaml b/examples/go/hello-world/kubefox/hack/environments/qa.yaml
@@ -1,3 +1,4 @@
+---
 apiVersion: kubefox.xigxog.io/v1alpha1
 kind: Environment
 metadata: