Skip to content

Update channel and release identifiers in documentation #3684

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmberAlston merged 2 commits into from
Dec 2, 2025
Merged

Update channel and release identifiers in documentation #3684

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d89f762
Update channel and release identifiers in documentation
AmberAlston Dec 2, 2025
d44379e
Fix MDX formatting and typos in enterprise-portal-configure.mdx
AmberAlston Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 34 additions & 4 deletions docs/vendor/enterprise-portal-configure.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,12 @@ The following describes some of the supported MDX template variables:
<td>`my-app`</td>
</tr>
<tr>
<td><code>{`{channel.name}`}</code></td>
<td><code>{`{channel.channelName}`}</code></td>
<td>Channel name</td>
<td>`Stable`</td>
</tr>
<tr>
<td><code>{`{channel.slug}`}</code></td>
<td><code>{`{channel.channelSlug}`}</code></td>
<td>Channel slug</td>
<td>`stable`</td>
</tr>
Expand All @@ -214,10 +214,30 @@ The following describes some of the supported MDX template variables:
<td>`1.2.3`</td>
</tr>
<tr>
<td><code>{`{release.sequence}`}</code></td>
<td><code>{`{release.releaseSequence}`}</code></td>
<td>Release sequence number</td>
<td>`42`</td>
</tr>
<tr>
<td><code>{`{release.releaseNotes}`}</code></td>
<td>Release notes in markdown</td>
<td>`<Note>Review the release notes above before proceeding with installation.</Note>`</td>
</tr>
<tr>
<td><code>{`{{release.isRequired}}`}</code></td>
<td>Boolean: is this a required release</td>
<td>Add a <code>ConditionalRender when={`{release.isRequired}`}</code> to generate a special message</td>
</tr>
<tr>
<td><code>{`{installOptions.isAirgap}`}</code></td>
<td>Boolean: air gap installation</td>
<td>Add a <code>ConditionalRender when={`{!installOptions.isAirgap}`}</code> to add an extra Pull Images step</td>
</tr>
<tr>
<td><code>{`{installOptions.installType}`}</code></td>
<td>Installation type (helm, linux, embedded)</td>
<td>Add a <code>ConditionalRender when={`{installOptions.installType === 'helm'}`}</code> to generate different cluster preparation instructions</td>
</tr>
<tr>
<td><code>{`{installOptions.adminConsoleUrl}`}</code></td>
<td>Admin Console URL (user input, dynamic)</td>
Expand All @@ -238,19 +258,29 @@ The following describes some of the supported MDX template variables:
<td>Enterprise Portal title (optional)</td>
<td>`MyApp Enterprise Portal`</td>
</tr>
<tr>
<td><code>{`{branding?.logo}`}</code></td>
<td>Custom logo URL (optional)</td>
<td>`www.mycompany.com/logo`</td>
</tr>
<tr>
<td><code>{`{branding?.primaryColor}`}</code></td>
<td>Primary brand color (optional)</td>
<td>`#4a53b0`</td>
</tr>
<tr>
<td><code>{`{branding?.secondaryColor}`}</code></td>
<td>Primary brand color (optional)</td>
<td>`#0066cc`</td>
</tr>
<tr>
<td><code>{`{branding?.supportPortalLink}`}</code></td>
<td>Support portal URL (optional)</td>
<td>`https://support.example.com`</td>
</tr>
<tr>
<td><code>{`{installation.licenseId}`}</code></td>
<td>Customer license ID</td>
<td>Unique Customer license ID</td>
<td>`2cHXb1RCttzpR0xvnNWyaZCgDBP`</td>
</tr>
<tr>
Expand Down