Skip to content

Commit 434ba08

Browse files
authored
Merge pull request #3684 from replicatedhq/update-mdx-docs
Update channel and release identifiers in documentation
2 parents 4897aba + d44379e commit 434ba08

File tree

1 file changed

+34
-4
lines changed

1 file changed

+34
-4
lines changed

docs/vendor/enterprise-portal-configure.mdx

Lines changed: 34 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -205,12 +205,12 @@ The following describes some of the supported MDX template variables:
205205
<td>`my-app`</td>
206206
</tr>
207207
<tr>
208-
<td><code>{`{channel.name}`}</code></td>
208+
<td><code>{`{channel.channelName}`}</code></td>
209209
<td>Channel name</td>
210210
<td>`Stable`</td>
211211
</tr>
212212
<tr>
213-
<td><code>{`{channel.slug}`}</code></td>
213+
<td><code>{`{channel.channelSlug}`}</code></td>
214214
<td>Channel slug</td>
215215
<td>`stable`</td>
216216
</tr>
@@ -220,10 +220,30 @@ The following describes some of the supported MDX template variables:
220220
<td>`1.2.3`</td>
221221
</tr>
222222
<tr>
223-
<td><code>{`{release.sequence}`}</code></td>
223+
<td><code>{`{release.releaseSequence}`}</code></td>
224224
<td>Release sequence number</td>
225225
<td>`42`</td>
226226
</tr>
227+
<tr>
228+
<td><code>{`{release.releaseNotes}`}</code></td>
229+
<td>Release notes in markdown</td>
230+
<td>`<Note>Review the release notes above before proceeding with installation.</Note>`</td>
231+
</tr>
232+
<tr>
233+
<td><code>{`{{release.isRequired}}`}</code></td>
234+
<td>Boolean: is this a required release</td>
235+
<td>Add a <code>ConditionalRender when={`{release.isRequired}`}</code> to generate a special message</td>
236+
</tr>
237+
<tr>
238+
<td><code>{`{installOptions.isAirgap}`}</code></td>
239+
<td>Boolean: air gap installation</td>
240+
<td>Add a <code>ConditionalRender when={`{!installOptions.isAirgap}`}</code> to add an extra Pull Images step</td>
241+
</tr>
242+
<tr>
243+
<td><code>{`{installOptions.installType}`}</code></td>
244+
<td>Installation type (helm, linux, embedded)</td>
245+
<td>Add a <code>ConditionalRender when={`{installOptions.installType === 'helm'}`}</code> to generate different cluster preparation instructions</td>
246+
</tr>
227247
<tr>
228248
<td><code>{`{installOptions.adminConsoleUrl}`}</code></td>
229249
<td>Admin Console URL (user input, dynamic)</td>
@@ -244,19 +264,29 @@ The following describes some of the supported MDX template variables:
244264
<td>Enterprise Portal title (optional)</td>
245265
<td>`MyApp Enterprise Portal`</td>
246266
</tr>
267+
<tr>
268+
<td><code>{`{branding?.logo}`}</code></td>
269+
<td>Custom logo URL (optional)</td>
270+
<td>`www.mycompany.com/logo`</td>
271+
</tr>
247272
<tr>
248273
<td><code>{`{branding?.primaryColor}`}</code></td>
249274
<td>Primary brand color (optional)</td>
250275
<td>`#4a53b0`</td>
251276
</tr>
277+
<tr>
278+
<td><code>{`{branding?.secondaryColor}`}</code></td>
279+
<td>Primary brand color (optional)</td>
280+
<td>`#0066cc`</td>
281+
</tr>
252282
<tr>
253283
<td><code>{`{branding?.supportPortalLink}`}</code></td>
254284
<td>Support portal URL (optional)</td>
255285
<td>`https://support.example.com`</td>
256286
</tr>
257287
<tr>
258288
<td><code>{`{installation.licenseId}`}</code></td>
259-
<td>Customer license ID</td>
289+
<td>Unique Customer license ID</td>
260290
<td>`2cHXb1RCttzpR0xvnNWyaZCgDBP`</td>
261291
</tr>
262292
<tr>

0 commit comments

Comments
 (0)