Merge pull request #3709 from replicatedhq/ep-email-history

paigecalvert · web-flow · commit b3b91e8d53ae · 2025-12-10T13:06:41.000-07:00
document email history feature for enterprise portal
diff --git a/docs/vendor/enterprise-portal-access.mdx b/docs/vendor/enterprise-portal-access.mdx
@@ -1,6 +1,6 @@
-# Access a Customer's Enterprise Portal
+# View a Customer's Enterprise Portal
 
-This topic describes how you can access the Enterprise Portal for a customer from the Vendor Portal. This is useful when testing your application installation and upgrade instructions, previewing customizations that you made to the Enterprise Portal, or managing Enterprise Portal users on behalf of one of your customers.
+This topic describes how you can log in to the Enterprise Portal for a customer from the Vendor Portal. This is useful when testing your application installation and upgrade instructions, previewing customizations that you made to the Enterprise Portal, or managing Enterprise Portal users on behalf of one of your customers.
 
 For information about how end users can sign up for an account and log in to the Enterprise Portal, see [Log In To and Use the Enterprise Portal](enterprise-portal-use).
 
diff --git a/docs/vendor/enterprise-portal-configure.mdx b/docs/vendor/enterprise-portal-configure.mdx
@@ -61,7 +61,9 @@ To manage Enterprise Portal settings:
 
 1. Click **Save**.
 
-## Customize Customer Emails {#configure-customer-emails}
+## Customize Emails {#configure-customer-emails}
+
+This section describes options for customizing the emails sent to customers through the Enteprise Portal. For information about how to view the delivery status of all emails sent to customers, see [View Email History and Delivery Status](#email-history) in _Manage Enterprise Portal Customer Access_.
 
 ### Configure Email Sender
 
@@ -129,7 +131,9 @@ The following template variables are available across multiple email types:
 | `{{release_notes}}` | Release notes content | "New features and bug fixes" |
 | `{{update_url}}` | Link to update/release page | https://portal.example.com/acme/releases |
 
-## Add a Link to Documentation
+## Customize User Instructions
+
+### Add a Link to Documentation
 
 For each of your supported install types, you can add a link your installation documentation. The link you provide is displayed on the Enterprise Portal **Install** page.
 
@@ -147,7 +151,7 @@ To add a link to your documentation in the Enterprise Portal:
 
 1. Click **Save changes**.
 
-## Add Pre- and Post-Install Instructions
+### Add Pre- and Post-Install Instructions
 
 For each of your supported install types, you can add custom pre- and post-install instructions for users. This is useful if there are additional prerequisites or follow-up steps that users need to complete in addition to the primary installation instructions.
 
@@ -169,13 +173,13 @@ To customize the pre- and post-install instructions for your application:
 
 1. Click **Save changes**.
 
-## Exclude Certain Images from Helm CLI Install Instructions
+### Exclude Certain Images from Helm CLI Install Instructions
 
 You can use the `kots.io/installer-only` annotation to exclude the images for an entire Helm chart or for one or more resoures in a Helm chart's templates from the Helm CLI installation instructions displayed in the Enterprise Portal. This annotation is useful for charts or resources that are required for deployments with a Replicated installer (KOTS, Embedded Cluster, kURL) but should not be visible or deployed when customers install with the Helm CLI.
 
 For more information, see [`kots.io/installer-only` Annotation](/vendor/packaging-include-resources#installer-only) in _Conditionally Include or Exclude Resources_.
 
-## Customize Channel-Specific Install Instructions (Alpha) {#customize-channel-install-instructions}
+### Customize Channel-Specific Install Instructions (Alpha) {#customize-channel-install-instructions}
 
 :::note
 Custom install instructions are Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
@@ -191,9 +195,9 @@ These custom installation instructions support MDX. MDX is a format that combine
 - **Built-in UI components**: Use UI components like code blocks, alerts, tabs, and progress indicators
 - **Conditional rendering**: Conditionally show or hide content. For example, show or hide certain steps based on the installation options supported by the customer's license
 
-### Customize Channel-Specific Instructions
+#### Add Channel-Specific Instructions
 
-To customize channel-specific installation instructions:
+To add custom, channel-specific installation instructions:
 
 1. In the Vendor Portal, go to **Enterprise Portal > Installation Instructions**.
 
@@ -215,7 +219,7 @@ To customize channel-specific installation instructions:
 
 1. Click **Save changes** to save your custom installation instructions.
 
-### Revert to Default Instructions
+#### Revert to Default Instructions
 
 To disable custom instructions for a channel and revert to the default automatically-generated instructions:
 
@@ -227,7 +231,7 @@ To disable custom instructions for a channel and revert to the default automatic
    Your custom documentation is saved in the **Channel customizations** MDX template editor. You can enable the custom instructions again by clicking **Enable** for the channel.
    :::
 
-### Supported MDX Template Variables {#vars}
+#### Supported MDX Template Variables {#vars}
 
 :::note
 For a complete list of available variables, use the autocomplete feature in the editor.
@@ -353,11 +357,11 @@ The following describes some of the supported MDX template variables:
   </tr>
 </table>
 
-### Supported MDX Components {#components}
+#### Supported MDX Components {#components}
 
 The following components are available in MDX templates. For examples of each component, see [Example](#example) below.
 
-#### Text and Formatting
+##### Text and Formatting
 
 <table>
   <thead>
@@ -431,7 +435,7 @@ The following components are available in MDX templates. For examples of each co
   </tbody>
 </table>
 
-#### Layout
+##### Layout
 
 <table>
   <thead>
@@ -466,7 +470,7 @@ The following components are available in MDX templates. For examples of each co
 </table>
 
 
-#### Installation Components
+##### Installation Components
 
 <table>
   <thead>
@@ -503,7 +507,7 @@ The following components are available in MDX templates. For examples of each co
 </table>
 
 
-#### Input Components
+##### Input Components
 
 <table>
   <thead>
@@ -548,7 +552,7 @@ The following components are available in MDX templates. For examples of each co
 </table>
 
 
-#### Display Components
+##### Display Components
 
 <table>
   <thead>
@@ -573,7 +577,7 @@ The following components are available in MDX templates. For examples of each co
   </tbody>
 </table>
 
-### MDX Templates Restrictions
+#### MDX Templates Restrictions
 
 MDX templates are validated for security before being saved. The following restrictions apply:
 
@@ -583,7 +587,7 @@ MDX templates are validated for security before being saved. The following restr
 - Dangerous HTML elements (script, iframe, embed) are not allowed
 - Template size is limited to 1MB
 
-### Example
+#### Example
 
 The following is an example of custom installation instructions that use MDX with conditional rendering based on installation type:
 
diff --git a/docs/vendor/enterprise-portal-invite.mdx b/docs/vendor/enterprise-portal-invite.mdx
@@ -1,30 +1,28 @@
-# Manage Customer Access to the Enterprise Portal
+# Manage Enterprise Portal Customer Access
 
-This topic describes how to control customer access to the Enterprise Portal from the Replicated Vendor Portal.
+This topic describes how to manage customer access to the Enterprise Portal from the Replicated Vendor Portal. It includes information about enabling the Enterprise Portal, managing user invitations, enabling SAML authentication for Enterprise Portal logins, and more.
 
 For information about how your end customers can manage, invite, and remove team members in their Enterprise Portal, see [Log In To and Use the Enterprise Portal](enterprise-portal-use).
 
-## Manage Customer Access to the Enterprise Portal {#manage-ep-access}
+## Manage Access to the Enterprise Portal {#manage-ep-access}
 
 You can enable and disable access to the Enterprise Portal for all customers, or on a per-customer basis. When access to the Enterprise Portal is disabled, the customer has access to the Replicated Download Portal instead.
 
 :::note
 The Entprise Portal supports Embedded Cluster and Helm CLI installation methods only. Customers that use KOTS in an existing cluster or kURL can continue to use the Download Portal. 
 :::
 
-To control customer access to the Enterprise Portal:
-
-* In the Vendor Portal, do one of the following to enable or disable Enterprise Portal access for your customers:
+Do one of the following to enable or disable Enterprise Portal access for your customers:
    
-   * Go to **Enterprise Portal > Customer Access**. For **Portal access**, enable or disable the toggle to control if all customers have access to the Enterprise Portal or the Download Portal.
+* Go to **Enterprise Portal > Customer Access**. For **Portal access**, enable or disable the toggle to control if all customers have access to the Enterprise Portal or the Download Portal.
 
-      ![enterprise portal access toggle](/images/enterprise-portal-access-toggle.png)
-      [View a larger version of this image](/images/enterprise-portal-access-toggle.png)
-   
-   * Go to **Customers** and select the target customer. On the customer's page, go to **Enterprise Portal access** and enable or disable the **Enterprise Portal access** toggle to control if the customer has access to the Enterprise Portal or the Download Portal.
+   ![enterprise portal access toggle](/images/enterprise-portal-access-toggle.png)
+   [View a larger version of this image](/images/enterprise-portal-access-toggle.png)
+
+* Go to **Customers** and select the target customer. On the customer's page, go to **Enterprise Portal access** and enable or disable the **Enterprise Portal access** toggle to control if the customer has access to the Enterprise Portal or the Download Portal.
 
-      ![customer-specific enterprise portal access toggle](/images/customer-enterprise-portal-access-toggle.png)
-      [View a larger version of this image](/images/customer-enterprise-portal-access-toggle.png)
+   ![customer-specific enterprise portal access toggle](/images/customer-enterprise-portal-access-toggle.png)
+   [View a larger version of this image](/images/customer-enterprise-portal-access-toggle.png)
 
 ## Configure Allowed Domains for User Invitations
 
@@ -42,33 +40,21 @@ To configure allowed domains for a customer's Enterprise Portal invitations:
 
 1. In the text box, enter a domain to add to the allowlist. Click **Add domain**. Add more domains as needed.
 
-## Enable SAML Authentication (Alpha) {#enable-saml}
+## View Email History and Delivery Status {#email-history}
 
-:::note
-SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
-:::
+To view Enterprise Portal email history and delivery status, do one of the following:
 
-You can enable and disable SAML authentication for the Enterprise Portal on a per customer basis. When SAML authentication is enabled, the customer can set up SAML SSO logins for the Enterprise Portal using their identity provider (IdP). When SAML authentication is disabled, Enterprise Portal users are not able  to log in using SAML, even if the customer had already configured SAML for their Enterprise Portal previously. For more information, see [About SAML Logins (Alpha)](enterprise-portal-use#about-saml) in _Log In and Use the Enterprise Portal_.
+* To view email history for a specific customer: In the Vendor Portal, go to **Customer > Enterprise Portal Access > Email History**. 
 
-To enable SAML authentication:
-
-1. In the Vendor Portal, go to **Customers** and select the target customer.
-
-1. On the customer's page, go to **Enterprise Portal access**. In the **Authentication** section, enable the **SAML Authentication** toggle.
-
-   ![Enterprise Portal SAML authentication](/images/enterprise-portal-saml-authentication.png)
-
-   [View a larger version of this image](/images/enterprise-portal-saml-authentication.png)
-
-   After you enable SAML authentication, the customer can configure SAML in the Enterprise Portal using their IdP. For more information, see [Configure SAML Authentication (Alpha)](/vendor/enterprise-portal-use#saml) in _Log In and Use the Enterprise Portal_.
+* To view email history for all customers: In the Vendor Portal, go to **Enterprise Portal > Customer Access > Email History**.
 
 ## Invite Users
 
 This section describes how to invite users to the Enterprise Portal from the Vendor Portal. Your customers can also invite users to the Enterprise Portal from the Enterprise Portal **Team settings** page. For more information about using the **Team settings** page, see [Manage Users](enterprise-portal-use#manage-users) in _Access and Use the Enterprise Portal_.
 
 To invite users to the Enterprise Portal:
 
-1. Enable access to the Enterprise Portal for the customer. See [Manage Customer Access to the Enterprise Portal](#manage-ep-access) above.
+1. Enable access to the Enterprise Portal for the customer. See [Manage Access to the Enterprise Portal](#manage-ep-access) above.
 
 1. (Optional) Customize the Enterprise Portal invitation email. For more information, see [Configure Invitation and Notification Emails](enterprise-portal-configure#configure-customer-emails) in _Customize the Enterprise Portal_.
 
@@ -98,3 +84,23 @@ To delete users from the Enterprise Portal:
    ![Delete user button](/images/enterprise-portal-delete-user.png)
 
    [View a larger version of this image](/images/enterprise-portal-delete-user.png)
+
+## Enable SAML Authentication (Alpha) {#enable-saml}
+
+:::note
+SAML Authentication to the Enterprise Portal is Alpha and subject to change. To access this feature, a feature flag must be enabled for your team. For more information, reach out to your Replicated account representative.
+:::
+
+You can enable and disable SAML authentication for the Enterprise Portal on a per customer basis. When SAML authentication is enabled, the customer can set up SAML SSO logins for the Enterprise Portal using their identity provider (IdP). When SAML authentication is disabled, Enterprise Portal users are not able  to log in using SAML, even if the customer had already configured SAML for their Enterprise Portal previously. For more information, see [About SAML Logins (Alpha)](enterprise-portal-use#about-saml) in _Log In and Use the Enterprise Portal_.
+
+To enable SAML authentication:
+
+1. In the Vendor Portal, go to **Customers** and select the target customer.
+
+1. On the customer's page, go to **Enterprise Portal access**. In the **Authentication** section, enable the **SAML Authentication** toggle.
+
+   ![Enterprise Portal SAML authentication](/images/enterprise-portal-saml-authentication.png)
+
+   [View a larger version of this image](/images/enterprise-portal-saml-authentication.png)
+
+   After you enable SAML authentication, the customer can configure SAML in the Enterprise Portal using their IdP. For more information, see [Configure SAML Authentication (Alpha)](/vendor/enterprise-portal-use#saml) in _Log In and Use the Enterprise Portal_.
diff --git a/docs/vendor/enterprise-portal-use.mdx b/docs/vendor/enterprise-portal-use.mdx
@@ -2,14 +2,14 @@
 
 This topic describes how to log in to the Replicated Enterprise Portal as a user, and how to use the features in the Enterprise Portal.
 
-For information about how to access the Enterprise Portal for a customer from the Vendor Portal, see [Access a Customer's Enterprise Portal](enterprise-portal-access).
-
 ## Log In To the Enterprise Portal
 
 :::note
 If SAML authentication has been enabled and configured for the Enterprise Portal it will be the preferred login method and attempted automatically. See [Configure SAML Authentication (Alpha)](#saml) below.
 :::
 
+This section describes how end customers can log in to their Enterprise Portal. Vendors can also log in to the Enterprise Portal for a customer from the Vendor Portal. For more information, see [View a Customer's Enterprise Portal](enterprise-portal-access).
+
 ### Log In From the Invitation Email
 
 Users can log in to the Enterprise Portal after they are invited to join a team. See [Invite or Delete Users](#invite-or-delete-users) below.
