WIP: multiline description

replicatedhq · Dec 19, 2023 · 13a3202 · 13a3202
1 parent 3541588
commit 13a3202
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/create-cluster/README.md b/create-cluster/README.md
@@ -47,7 +47,12 @@ create_cluster ---> cluster_kubeconfig
 | nodes |  | False | Number of nodes to provision |
 | instance-type |  | False | Instance type to provision |
 | timeout-minutes | 20 | False | Time to wait for the cluster to have a status of `running` |
-| tags |  | False | Tags to assign to the cluster.<br>Example:<br>```<br>tags: \|<br>  - key: "department"<br>    value: "engineering"<br>```<br> |
+| tags |  | False | Tags to assign to the cluster. Example: ```
+tags: \|
+  - key: "department"
+    value: "engineering"
+```
+ |
 | 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
@@ -33,9 +33,7 @@ inputs:
     default: '20'
   tags:
     description: |
-      Tags to assign to the cluster.
-      Example:
-      ```
+      Tags to assign to the cluster. Example: ```
       tags: \|
         - key: "department"
           value: "engineering"

diff --git a/docs/generate-readme/action-to-mermaid.py b/docs/generate-readme/action-to-mermaid.py
@@ -54,7 +54,7 @@ def generate_inputs(action_yaml_file):
             defaultVal = data['inputs'][input_name]['default'] if 'default' in data['inputs'][input_name] else ""
             requiredVal = data['inputs'][input_name]['required'] if 'required' in data['inputs'][input_name] else True
             descriptionVal = data['inputs'][input_name]['description'] if 'description' in data['inputs'][input_name] else ""
-            inputs += "| " + input_name + " | " + defaultVal + " | " + str(requiredVal) + " | " + descriptionVal.replace('\n','<br>') + " |\n"
+            inputs += "| " + input_name + " | " + defaultVal + " | " + str(requiredVal) + " | " + descriptionVal + " |\n"
 
     return inputs