update docs

fastmachinelearning · Dec 4, 2024 · 5795133 · 5795133
1 parent fa9f43b
commit 5795133
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/.github/workflows/helm-lint.yaml b/.github/workflows/helm-lint.yaml
@@ -2,7 +2,7 @@ name: helm lint
 
 on:
   push:
-    branches: ["master", "default-values"]
+    branches: ["master"]
 
 jobs:
   helm-lint:

diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -16,7 +16,18 @@ Installation
 
    .. code:: shell
 
-      helm upgrade --install super-sonic ./helm --values helm/values.yaml -n <namespace>
+      git clone https://github.com/fastmachinelearning/SuperSONIC
+      cd SuperSONIC
+      helm upgrade --install SuperSONIC ./helm --values values/your-values.yaml -n <namespace>
+
+   Nicer installation from a Helm repository coming soon in `v0.1`
+
+Uninstall SuperSONIC
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+   .. code:: shell
+
+      helm uninstall SuperSONIC  -n <namespace>
 
 Architecture
 ~~~~~~~~~~~~~~~
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,7 +2,7 @@ name: helm lint @@
     on:
       push:
-        branches: ["master", "default-values"]
+        branches: ["master"]
     jobs:
       helm-lint:
@@ Expand Down @@