From 0299fa94d131421cd137d285db30123f6b6a1059 Mon Sep 17 00:00:00 2001 From: alicenstar <67430892+alicenstar@users.noreply.github.com> Date: Wed, 29 Oct 2025 13:22:24 -0500 Subject: [PATCH 1/7] add custom install instructions docs --- docs/vendor/enterprise-portal-configure.mdx | 409 +++++++++++++++++- ...portal-custom-instructions-helm-online.png | Bin 0 -> 866053 bytes ...ortal-custom-instructions-linux-online.png | Bin 0 -> 820884 bytes 3 files changed, 406 insertions(+), 3 deletions(-) create mode 100644 static/images/enterprise-portal-custom-instructions-helm-online.png create mode 100644 static/images/enterprise-portal-custom-instructions-linux-online.png diff --git a/docs/vendor/enterprise-portal-configure.mdx b/docs/vendor/enterprise-portal-configure.mdx index 7438b1d61d..9df8394000 100644 --- a/docs/vendor/enterprise-portal-configure.mdx +++ b/docs/vendor/enterprise-portal-configure.mdx @@ -86,9 +86,14 @@ To configure customer emails: The install instructions available in the Enterprise Portal are automatically generated based on the install types and options enabled in the customer's license. For more information about managing the installation types and options, see [Manage Install Types for a License](/vendor/licenses-install-types). -You can also customize the documentation that is displayed in the Enterprise Portal by including a link to your installation instructions or by adding your own pre- and post-installation instructions. +You can customize the documentation that is displayed in the Enterprise Portal in two ways: -To customize documentation: +- **Knowledge Base**: Add documentation links and pre/post-installation instructions that apply to all release channels +- **Channel Customizations**: Create custom, channel-specific installation instructions using MDX templates + +### Add Documentation Links and Instructions + +To customize documentation at the app level: 1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**. @@ -103,7 +108,405 @@ To customize documentation: 1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes. :::note - By default, these same instructions are shown for all release channels. To add channel-specific instructions, go to the **Channel customizations** section. + By default, these same instructions are shown for all release channels. To add channel-specific instructions, see [Customize Channel-Specific Install Instructions](#customize-channel-install-instructions). ::: 1. Click **Save changes**. + +### Customize Channel-Specific Install Instructions (Alpha) {#customize-channel-install-instructions} + +:::note +This feature is in Alpha and subject to change. +::: + +You can create custom installation instructions for each release channel using MDX templates. This allows you to provide tailored installation experiences with dynamic content based on customer configuration, release information, and branding. + +#### About MDX Templates + +MDX is a format that combines Markdown with JSX, allowing you to use pre-built components and template variables in your installation instructions. MDX templates support: + +- **Template Variables**: Access dynamic data like application name, release version, registry settings, and customer inputs +- **Custom Components**: Use pre-built UI components like code blocks, alerts, tabs, and progress indicators +- **Conditional Rendering**: Show or hide content based on installation options or environment +- **Progressive Enhancement**: Automatically falls back to default instructions if custom instructions are disabled + +#### Create Custom Install Instructions + +To create channel-specific installation instructions: + +1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**. + +1. Scroll to the **Channel customizations** section. + +1. Select the channel you want to customize from the dropdown. + +1. Toggle **Enable custom install instructions** to enable the MDX template editor. + +1. In the MDX template editor, write your custom installation instructions using Markdown, template variables, and MDX components. + + The editor provides autocomplete for available template variables and components. Press `Ctrl+Space` to see suggestions. + +#### Template Variables + +The following template variables are available in MDX templates: + +
| Variable | +Description | +Example | +
|---|---|---|
{`{app.name}`} |
+ Application name | +My Application | +
{`{app.slug}`} |
+ Application slug (identifier) | +my-app | +
{`{channel.name}`} |
+ Channel name | +Stable | +
{`{channel.slug}`} |
+ Channel slug | +stable | +
{`{release.versionLabel}`} |
+ Release version number | +1.2.3 | +
{`{release.sequence}`} |
+ Release sequence number | +42 | +
{`{installOptions.adminConsoleUrl}`} |
+ Admin Console URL (user input, dynamic) | +https://admin.example.com | +
{`{installOptions.proxyUrl}`} |
+ HTTP/HTTPS proxy URL (user input, dynamic) | +https://proxy.example.com:8080 | +
{`{installOptions.privateRegistryUrl}`} |
+ Private registry hostname (user input, dynamic) | +registry.example.com:5000 | +
{`{branding?.title}`} |
+ Enterprise Portal title (optional) | +MyApp Enterprise Portal | +
{`{branding?.primaryColor}`} |
+ Primary brand color (optional) | +#4a53b0 | +
{`{branding?.supportPortalLink}`} |
+ Support portal URL (optional) | +https://support.example.com | +
{`{installation.licenseId}`} |
+ Customer license ID | +2cHXb1RCttzpR0xvnNWyaZCgDBP | +
{`{installation.serviceAccountId}`} |
+ Service account identifier | +2cHXb1RCttzpR0xvnNWyaZCgDBP | +
{`{images.raw}`} |
+ Array of image names without registry (Helm only) | +["nginx:1.19", "postgres:13"] | +
{`{images.full}`} |
+ Array of complete image references (Helm only) | +["registry.replicated.com/..."] | +
vrCrGj<*))mgaMkdO8S-n0{f~^S@W;A;LMko2;ovj=5*yW`%9AwGFJZCr-Kt
zcs&kWTWhL`;QWYbmW+g4UGn%{!l&s#XmTE6Vz(yf!`Xr9-90p-_qq-QnW_?}vP62d
zF NvsYS-WfTSn!Y(6$M?~AL*)kg(
zkMpN_W-f>7%ionEb$Hca=PQzZXniHW;sC!u8@MfibDOj9UMb!P-f0c##1<>0%y*L>
zL-+m0sBUG#YKK=+GpF`jZ(9{scF*yDAAfp@$~550;rm*`pC@gRYqy-Z;|Gn@6^Z-Y
zJ`rQtf;7%iH4&eyrN0p8Z)waJk %JJRZnfg%T
z4kX7hI8H$C#j;6R8lr#AE@KEk34S51T1k$GrY?%x8~k7`+L_dlC^RU~aBD@tAm!Vj
z{j~-g5Q|-ln&bEwjfqEKsgf&Y_kCB=jy&0$)UZo6r;d(SW?%;Al;rJ{4EnYwVm!OUeii>|
sK6$!AhojS&{@wR
tEhzTMPH!K