From 375646292f79dcfebb862ab2336532d527cbf3b7 Mon Sep 17 00:00:00 2001
From: Matthew B <106352182+artntek@users.noreply.github.com>
Date: Mon, 3 Jun 2024 15:41:35 -0700
Subject: [PATCH] doc update

---
 helm/README.md        | 21 +++++++++++++++++----
 helm/config/config.js |  1 +
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/helm/README.md b/helm/README.md
index 5052d0fd1..caacac8eb 100644
--- a/helm/README.md
+++ b/helm/README.md
@@ -1,6 +1,20 @@
 # MetacatUI Helm chart
 
-This is a simple helm chart for debugging a MetacatUI deployment. It works by:
+This is a simple helm chart for debugging a MetacatUI deployment. 
+
+## Steps to get started for deployment in a Kubernetes cluster:
+
+1. modify values.yaml as appropriate
+2. install the helm chart:
+```shell
+$ helm -n knb upgrade --install knbmcui ./helm
+```
+There's no need to set up any persistent storage - the chart will automatically check out the 
+metacatui static content from GitHub, and install it on an "emptyDir" that is automatically 
+created for you. 
+
+
+## Steps to get started for development on localhost (e.g. Rancher Desktop/Docker Desktop):
 
 0. Create a namespace `mcui` for the deployment (or pick another of your liking)
 1. Create a PV that is mapped to a local `hostPath` directory that contains the web files to deploy
@@ -9,8 +23,8 @@ This is a simple helm chart for debugging a MetacatUI deployment. It works by:
 
 To deploy this, you need to 1) create the PV and PVC for your system layout, 2) modify the values.yaml to your hostname for the Ingress definition, and 3) install the helm chart:
 
-```bash
-❯ helm -n mcui upgrade --install mcui ./helm
+```shell
+$ helm -n mcui upgrade --install --debug mcui ./helm
 Release "mcui" has been upgraded. Happy Helming!
 NAME: mcui
 LAST DEPLOYED: Wed Apr 17 19:45:58 2024
@@ -30,4 +44,3 @@ MetacatUI.AppConfig = {
       baseUrl: "https://dev.nceas.ucsb.edu/knb/d1/mn"
 }
 ```
-
diff --git a/helm/config/config.js b/helm/config/config.js
index 19ba4ed47..0dbaa72af 100644
--- a/helm/config/config.js
+++ b/helm/config/config.js
@@ -2,6 +2,7 @@ MetacatUI.AppConfig = {
     root: {{ .Values.appConfig.root | quote }},
     theme: {{ .Values.appConfig.theme | quote }},
     baseUrl: {{ .Values.appConfig.baseUrl | quote }}
+    {{/* Add any new keys to these lists, and they will be populated automatically if set */}}
     {{- $optionalStringValues := list
         "d1CNBaseUrl"
         "mapKey"