From 11d3a262d0a027f2f55eb4ccdfc0eea7ab422f35 Mon Sep 17 00:00:00 2001 From: KaradzaJuraj <101581637+KaradzaJuraj@users.noreply.github.com> Date: Tue, 5 Nov 2024 16:22:47 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=96=EF=B8=8F=20Update=20docs=20to=20inclu?= =?UTF-8?q?de=20`x-suggestions`=20(#659)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * update docs to include x-suggestions * update type --- web/docs/templates/templates.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/docs/templates/templates.md b/web/docs/templates/templates.md index 191847b5..c4feca49 100644 --- a/web/docs/templates/templates.md +++ b/web/docs/templates/templates.md @@ -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. @@ -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.
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 |