doc(GitOpsConfig): Fix config example

Fixes #162 (until we officially release and document apiVersion v2)
baloise · Aug 3, 2021 · 8452a03 · 8452a03
1 parent 8d9546a
commit 8452a03
Showing 1 changed file with 6 additions and 6 deletions.
diff --git a/docs/includes/preview-configuration.md b/docs/includes/preview-configuration.md
@@ -30,7 +30,7 @@ Make sure that your *app repository* contains a `.gitops.config.yaml` file. This
 apiVersion: v1
 applicationName: app-xy
 previewConfig:
-  host: {PREVIEW_NAMESPACE}.example.tld
+  host: '{PREVIEW_NAMESPACE}.example.tld'
 # template:                              # optional section
 #   organisation: templates              # optional (default: target.organisation)
 #   repository: template-repo            # optional (default: target.repository)
@@ -40,18 +40,18 @@ previewConfig:
     organisation: deployments
     repository: deployment-config-repo
 #   branch: master                       # optional (defaults to repo's default branch)
-    namespace: {APPLICATION_NAME}-{PREVIEW_ID_HASH}-preview  # optional (default: '{APPLICATION_NAME}-{PREVIEW_ID}-{PREVIEW_ID_HASH}-preview',
-                                                             #           Invalid characters in PREVIEW_ID will be replaced. PREVIEW_ID will be
-                                                             #           truncated if max namespace length exceeds 63 chars.)
+    namespace: '{APPLICATION_NAME}-{PREVIEW_ID_HASH}-preview'  # optional (default: '{APPLICATION_NAME}-{PREVIEW_ID}-{PREVIEW_ID_HASH}-preview',
+                                                               #           Invalid characters in PREVIEW_ID will be replaced. PREVIEW_ID will be
+                                                               #           truncated if max namespace length exceeds 63 chars.)
   replace:
     Chart.yaml:
       - path: name
-        value: {PREVIEW_NAMESPACE}
+        value: '{PREVIEW_NAMESPACE}'
     values.yaml:
       - path: app.image
         value: registry.example.tld/my-app:{GIT_HASH}
       - path: route.host
-        value: {PREVIEW_HOST}
+        value: '{PREVIEW_HOST}'
 ```
 
 #### Variables