Skip to content

Commit

Permalink
✖️ Update docs to include x-suggestions (#659)
Browse files Browse the repository at this point in the history
* update docs to include x-suggestions

* update type
  • Loading branch information
KaradzaJuraj authored Nov 5, 2024
1 parent 0784e60 commit 11d3a26
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions web/docs/templates/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ Cyclops renders the _New Module_ form based on your Helm templates. We have a pu

Although we have a **GitHub repository** to store our charts, there are other ways of storing them. Cyclops can access charts stored in three different ways:

1. **1. GitHub Repository**
2. **2. Helm Chart Repository**
3. **3. OCI Repository**
1. **GitHub Repository**
2. **Helm Chart Repository**
3. **OCI Repository**

The **`values.schema.json` is a necessary component** in your templates. This file is usually used to impose a structure on the `values.yaml` file, but it is also crucial for rendering the GUI in Cyclops.

Expand Down Expand Up @@ -37,4 +37,4 @@ In addition to the usual schema, we added more fields to help our users get as m
| `order` | string array | Defines the order of the fields in an object type property. <br/> Each time you use `properties`, you should also define the order of those properties | - |
| `fileExtension` | string | Sometimes, you would like your text field not just to be a field but also to get some highlighting based on the type of string you are saving. You can specify that in this field | `text`, `sh`, `json`, `yaml`, `toml`, `javascript`, `typescript` |
| `immutable` | boolean | If `true`, the field can't be updated through the UI when __editing__ a module. Can be edited when the Module is first created or via manifest in the cluster. | `true`, `false` (`false` by default) |

| `x-suggestions` | string array | Rendered as dropdown that accepts free input as well. You can check out how to use it [here](https://github.com/cyclops-ui/templates/blob/x-suggestions-demo/app-template/values.schema.json) | array of strings |

0 comments on commit 11d3a26

Please sign in to comment.