Skip to content

Commit 3ae48a7

Browse files
authored
Merge pull request #4039 from replicatedhq/deemphasize-kots-in-ref--material-2
Make Config and ConfigValues content work for EC v3
2 parents ad9b543 + 0ce9b1e commit 3ae48a7

18 files changed

Lines changed: 354 additions & 466 deletions

docs/partials/config/_defaultExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99
value: ""
1010
default: change me
1111
```
12-
![Default change me value displayed under the config field](/images/config-default.png)
12+
<img width="500px" alt="Default change me value displayed under the config field" src="/images/config-default.png"/>
1313
1414
[View a larger version of this image](/images/config-default.png)

docs/partials/config/_helpTextExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
help_text: Check to enable the HTTP listener
88
type: bool
99
```
10-
![Config field with help text underneath](/images/config-help-text.png)
10+
<img width="500px" alt="Config field with help text underneath" src="/images/config-help-text.png"/>
1111
1212
[View a larger version of this image](/images/config-help-text.png)
Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
It can be useful to conditionally show or hide fields so that your users are only provided the configuration options that are relevant to them. This helps to reduce user error when configuring the application. Conditional statements in the `when` property can be used to evaluate things like the user's environment, license entitlements, and configuration choices. For example:
2-
* The Kubernetes distribution of the cluster
3-
* If the license includes a specific feature entitlement
4-
* The number of users that the license permits
5-
* If the user chooses to bring their own external database, rather than using an embedded database offered with the application
1+
This lets you conditionally show or hide fields so your end customers only see the options that are relevant to them.
62

7-
You can construct conditional statements in the `when` property using Replicated template functions. Replicated template functions are a set of custom template functions based on the Go text/template library. For more information, see [About Replicated Template Functions](/reference/template-functions-about).
3+
You can use Go template functions to create conditional statements. Replicated provides a set of Go template functions that you can use to evaluate conditions like the user's environment, their license entitlements, and their previous configuration choices. For more information, see [About Replicated Template Functions](/reference/template-functions-about).
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
:::note
2-
When you assign a template function that generates a value to a `value` property, you can use the `readonly` and `hidden` properties to define whether or not the generated value is ephemeral or persistent between changes to the configuration settings for the application. For more information, see [RandomString](template-functions-static-context#randomstring) in _Static Context_.
3-
:::
1+
When you assign a template function that generates a value to a `value` property, you can use the `readonly` and `hidden` properties to define whether or not the generated value is ephemeral or persistent between changes to the configuration settings for the application. For more information, see [RandomString](template-functions-static-context#randomstring) in _Static Context_.

docs/partials/config/_readonlyExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
value: "{{repl RandomString 20}}"
1111
readonly: true
1212
```
13-
![Default change me value displayed under the config field](/images/config-readonly.png)
13+
<img width="500px" alt="Default change me value displayed under the config field" src="/images/config-readonly.png"/>
1414
1515
[View a larger version of this image](/images/config-readonly.png)

docs/partials/config/_recommendedExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
default: "0"
66
recommended: true
77
```
8-
![config field with green recommended tag](/images/config-recommended-item.png)
8+
<img width="500px" alt="config field with green recommended tag" src="/images/config-recommended-item.png"/>
99
1010
[View a larger version of this image](/images/config-recommended-item.png)

docs/partials/config/_requiredExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,6 @@
1010
default: change me
1111
required: true
1212
```
13-
![config field with yellow required tag](/images/config-required-item.png)
13+
<img width="500px" alt="config field with yellow required tag" src="/images/config-required-item.png"/>
1414
1515
[View a larger version of this image](/images/config-required-item.png)

docs/partials/config/_typeExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
type: bool
88
default: "0"
99
```
10-
![field named HTTP Enabled with disabled checkbox](/images/config-screen-bool.png)
10+
<img width="500px" alt="field named HTTP Enabled with disabled checkbox" src="/images/config-screen-bool.png"/>
1111
1212
[View a larger version of this image](/images/config-screen-bool.png)

docs/partials/config/_valueExample.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@
88
type: text
99
value: "{{repl RandomString 20}}"
1010
```
11-
![config field with random string as HTML input](/images/config-value-randomstring.png)
11+
<img width="500px" alt="config field with random string as HTML input" src="/images/config-value-randomstring.png"/>
1212
1313
[View a larger version of this image](/images/config-value-randomstring.png)
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
* The `when` property accepts the following types of values:
22
* Booleans
33
* Strings that match "true", "True", "false", or "False"
4-
5-
[Replicated template functions](/reference/template-functions-about) can be used to render these supported value types.
64
* For the `when` property to evaluate to true, the values compared in the conditional statement must match exactly without quotes

0 commit comments

Comments
 (0)