fix: description readme ip-family (#66)

replicatedhq · May 21, 2024 · 1765341 · 1765341
1 parent a4ab8f8
commit 1765341
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/create-cluster/README.md b/create-cluster/README.md
@@ -62,7 +62,7 @@ create_cluster ---> cluster_kubeconfig
 | timeout-minutes | 20 | False | Time to wait for the cluster to have a status of `running` |
 | node-groups |  | False | Node groups to provision.<br>Example:<br><pre>node-groups: \|<br>  - name: "worker"<br>    instance-type: "t3.medium"<br>    disk: 100<br>    nodes: 3</pre><br> |
 | tags |  | False | Tags to assign to the cluster.<br>Example:<br><pre>tags: \|<br>  - key: "department"<br>    value: "engineering"</pre><br> |
-| ip-family |  | False | IP Family to use for the cluster (ipv4|ipv6|dual) |
+| ip-family |  | False | IP Family to use for the cluster (ipv4, ipv6 or dual) |
 | kubeconfig-path |  | False | If specified, the kubeconfig will be written to this path |
 | export-kubeconfig | false | False | Export the KUBECONFIG variable (true/false) |
 

diff --git a/create-cluster/action.yml b/create-cluster/action.yml
@@ -57,7 +57,7 @@ inputs:
           value: "engineering"</pre>
     required: false
   ip-family:
-    description: "IP Family to use for the cluster (ipv4|ipv6|dual)"
+    description: "IP Family to use for the cluster (ipv4, ipv6 or dual)"
     required: false
   kubeconfig-path:
     description: "If specified, the kubeconfig will be written to this path"

diff --git a/prepare-cluster/README.md b/prepare-cluster/README.md
@@ -86,7 +86,7 @@ prepare_cluster ---> cluster_kubeconfig
 | timeout-minutes | 20 | False | Time to wait for the cluster to have a status of `running` |
 | node-groups |  | False | Node groups to provision.<br>Example:<br><pre>node-groups: \|<br>  - name: "worker"<br>    instance-type: "t3.medium"<br>    disk: 100<br>    nodes: 3</pre><br> |
 | tags |  | False | Tags to assign to the cluster.<br>Example:<br><pre>tags: \|<br>  - key: "department"<br>    value: "engineering"</pre><br> |
-| ip-family |  | False | IP Family to use for the cluster (ipv4|ipv6|dual) |
+| ip-family |  | False | IP Family to use for the cluster (ipv4, ipv6 or dual) |
 | kubeconfig-path |  | False | If specified, the kubeconfig will be written to this path |
 | export-kubeconfig | false | False | Export the KUBECONFIG variable (true/false) |
 | helm-values |  | False | A Helm values.yaml file to use |

diff --git a/prepare-cluster/action.yml b/prepare-cluster/action.yml
@@ -70,7 +70,7 @@ inputs:
           value: "engineering"</pre>
     required: false
   ip-family:
-    description: "IP Family to use for the cluster (ipv4|ipv6|dual)"
+    description: "IP Family to use for the cluster (ipv4, ipv6 or dual)"
     required: false
   kubeconfig-path:
     description: 'If specified, the kubeconfig will be written to this path'