Merge pull request #3662 from replicatedhq/131359

paigecalvert · web-flow · commit 23cba5845d4b · 2025-11-20T09:08:07.000-07:00
Improvements to Enterprise Portal docs
diff --git a/docs/intro.mdx b/docs/intro.mdx
@@ -223,7 +223,7 @@ import clsx from 'clsx';
           </div>
           <div className={clsx("col", "col--4")}>
             <div className="browse-docs-link-container">
-              <a href="/vendor/enterprise-portal-invite" className="browse-docs-link">Manage Enterprise Portal Access</a>
+              <a href="/vendor/enterprise-portal-invite" className="browse-docs-link">Manage Customer Access to the Enterprise Portal</a>
               <p className="browse-docs-link-description">Invite and manage customer portal users</p>
             </div>
           </div>
diff --git a/docs/vendor/customer-reporting.md b/docs/vendor/customer-reporting.md
@@ -68,7 +68,7 @@ You can use the Download Portal to give your customers access to the files they
 ### Enterprise Portal (Beta)
 
 :::note
-The **Enterprise Portal** section is available only for customers with the Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
+The **Enterprise Portal** section is available only for customers with the Enterprise Portal enabled. For more information about how to enable the Enterprise Portal for a customer, see [Manage Customer Access to the Enterprise Portal](/vendor/enterprise-portal-invite).
 :::
 
 The following shows an example of the **Enterprise Portal** section:
diff --git a/docs/vendor/enterprise-portal-about.mdx b/docs/vendor/enterprise-portal-about.mdx
@@ -45,7 +45,7 @@ For information about using the Enterprise Portal, see [Access and Use the Enter
 
 The Enterprise Portal is the next generation version of the Replicated Download Portal. Compared to the Download Portal, the Enterprise Portal not only provides access to installation assets and instructions, but also allows users to track available updates, manage their team and service accounts, view the status of their instances, view license details, and more. These features are designed to make it easier for your customers to manage their instances of your application from a centralized location outside of the installation environment.
 
-For more information about enabling Enterprise Portal access for your customers that install using either Embedded Cluster or the Helm CLI, see [Manage Enterprise Portal Access](enterprise-portal-invite).
+For more information about enabling Enterprise Portal access for your customers that install using either Embedded Cluster or the Helm CLI, see [Manage Customer Access to the Enterprise Portal](enterprise-portal-invite).
 
 :::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. 
diff --git a/docs/vendor/enterprise-portal-access.mdx b/docs/vendor/enterprise-portal-access.mdx
@@ -0,0 +1,43 @@
+# Access 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.
+
+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).
+
+## Log In Using a One-Time Link
+
+You can access the Enterprise Portal for a customer using a one-time login. This is useful for quickly accessing the Enteprise Portal, or if you must not create an account in the customer's Enterprise Portal.
+
+To access the Enterprise Portal for a customer with a one-time login:
+
+1. In the Vendor Portal, go to **Customers > [Customer Name] > Enterprise Portal Access**.
+
+1. In the **Login to portal** section, click **Login to portal**. This generates a one-time login and opens the Enterprise Portal for the customer.
+
+   ![Login to portal section](/images/enterprise-portal-one-time-login.png)
+
+   [View a larger version of this image](/images/enterprise-portal-one-time-login.png)
+
+## Log In With an Account
+
+:::note
+If your email address is not yet added to the customer's Enterprise Portal team, send an invitation before attempting to log in. For information about how to add users to a customer's Enterprise Portal from the Vendor Portal, see [Invite Users](enterprise-portal-invite#invite-users) in _Manage Customer Access to the Enterprise Portal_.
+:::
+
+To access the Enterprise Portal for a customer by logging in with an account:
+
+1. In the Vendor Portal, do one of the following to get the unique Enterprise Portal link for the customer:
+   * Go to **Customers > [Customer Name] > Enterprise Portal Access**. Click **View customer's portal link**.
+
+      ![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)
+
+   * Go to **Customers > [Customer Name] > Reporting** and click **View** in the **Enterprise Portal** section. 
+
+      ![Enterprise Portal section of customer reporting page](/images/customer-reporting-enterprise-portal.png)
+
+      [View a larger version of this image](/images/customer-reporting-enterprise-portal.png)
+    
+
+1. In the dialog, enter the email address for the existing Enterprise Portal user and click **Continue with email**. The Vendor Portal generates a verification code and sends it to the email address.
diff --git a/docs/vendor/enterprise-portal-invite.mdx b/docs/vendor/enterprise-portal-invite.mdx
@@ -1,8 +1,8 @@
-# Manage Enterprise Portal Access
+# Manage Customer Access to the Enterprise Portal
 
-This topic describes how to enable or disable customer access to the Enterprise Portal. It also describes how to invite users to the Enterprise Portal from the Replicated Vendor Portal.
+This topic describes how to control customer access to the Enterprise Portal from the Replicated Vendor Portal.
 
-For information about customizing the invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
+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}
 
diff --git a/docs/vendor/enterprise-portal-self-serve-signup.mdx b/docs/vendor/enterprise-portal-self-serve-signup.mdx
@@ -1,8 +1,8 @@
-# Self-Service Enterprise Portal Sign-Ups
+# Enable Self-Service Sign-Ups
 
 This topic describes how to enable Enterprise Portal self-service sign-ups. This allows users to access your application by signing up for Trial or Community licenses through the Enterprise Portal.
 
-For information about customizing the Trial Signup invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
+For information about how your future and prospective customers can sign up for an account after self-service sign-ups are enabled, see [Log In To and Use the Enterprise Portal](enterprise-portal-use).
 
 ## Overview
 
@@ -20,7 +20,7 @@ To enable Enterprise Portal self-service sign-ups:
 
 1. (Optional) For **Terms and Conditions URL**, enter a URL to the terms and conditions that the user must acknowlwedge before proceeding with signup.
 
-1. For **License Configuration**, configure the default settings for licenses created through self-service signups, including the default channel, expiration date, license type (trial or community), supported installation types, and other support features.
+1. For **License Configuration**, configure the default settings for licenses created through self-service signups, including the default channel, expiration date, license type (trial or community), supported installation types, and other support features. For information about customizing the Trial Signup invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
 
 1. Click **Save**.
 
diff --git a/docs/vendor/enterprise-portal-use.mdx b/docs/vendor/enterprise-portal-use.mdx
@@ -1,28 +1,46 @@
-# Access and Use the Enterprise Portal
+# Log In To and Use the Enterprise Portal
 
-This topic describes how to access and use the Replicated Enterprise Portal.
+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.
 
-## Access 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).
 
-To access the Enterprise Portal for a customer:
+## Log In To the Enterprise Portal
 
-1. If your email address is not yet added to the customer's Enterprise Portal team, send an invitation. See [Invite Users](enterprise-portal-invite#invite-users). You can follow the link in the invitation email to access the Enterprise Portal.
+### Log in From the Invitation Email
 
-1. In the Vendor Portal, do one of the following to get the unique Enterprise Portal link for the customer:
-   * Go to **Customers > [Customer Name] > Enterprise Portal Access**. Click **View customer's portal link**.
+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.
 
-      ![customer-specific enterprise portal access toggle](/images/customer-enterprise-portal-access-toggle.png)
+ * Go to your email account and open the automated invitation email. Click **Activate your account** to log in.
 
-      [View a larger version of this image](/images/customer-enterprise-portal-access-toggle.png)
+    <img alt="enterprise portal invitation email" src="/images/enterprise-portal-invitation-email.png" width="600px"/>
 
-   * Go to **Customers > [Customer Name] > Reporting** and click **View** in the **Enterprise Portal** section. 
+    [View a larger version of this image](enterprise-portal-invitation-email.png)
 
-      ![Enterprise Portal section of customer reporting page](/images/customer-reporting-enterprise-portal.png)
+### Sign Up for a Self-Service Account
 
-      [View a larger version of this image](/images/customer-reporting-enterprise-portal.png)
-    
+If self-service sign-ups are enabled for the application, users can create an account in the Enterprise Portal without being invited. The primary use case for self-service account creation is to sign up for a trial or community version of the software.
+
+:::note
+For information about how to enable self-service sign-ups from the Vendor Portal, see [Enable Self-Service Sign-Ups](/vendor/enterprise-portal-self-serve-signup).
+:::
+
+To sign up for a self-service account and log in to the Enteprise Portal:
+
+1. Go to the sign-up page URL.
+
+    :::note
+    For information about how to find the unique sign-up URL in the Vendor Portal, see [Share Your Sign-Up URL](/vendor/enterprise-portal-self-serve-signup#share-trial-url) in _Enable Self-Service Sign-Ups_.
+    :::
+
+1. Enter your company name and email address, agree to the terms and conditions, and click **Create account**.
+
+    The following shows an example of a self-service sign-up page for an application:
 
-1. In the dialog, enter the email address for the existing Enterprise Portal user and click **Continue with email**. The Vendor Portal generates a verification code and sends it to the email address.
+    <img alt="Self-Service Sign-Up Interaction" src="/images/self-serve-signup-screen.png" width="400px"/>
+
+    [View a larger version of this image](/images/self-serve-signup-screen.png)
+
+1. Go to your email account and open the automated account creation email. Follow the link provided in the email to log in.    
 
 ## View Install and Update Instructions
 
@@ -58,14 +76,16 @@ To view update instructions in the Enterprise Portal:
 
 1. If an **Update available** button is displayed, click it to view and follow the update instructions for the given instance.
 
-## View Active and Inactive Instances
+## View Instance Records
 
 Users can view their active and inactive instances in the Enterprise Portal, including the instance status and other details. 
 
 :::note
-Air gap instance records do not appear in the Enterprise Portal until the end customer creates an air gap instance record by either uploading a support bundle for that instance or manually entering instance information. 
+Air gap instance records do not appear in the Enterprise Portal until the user adds a record by either uploading a support bundle for the instance or manually entering instance information. See [Create an Air Gap Instance Record](#create-an-air-gap-instance-record) below.
 :::
 
+### View Active and Inactive Instances
+
 To view instances in the Enterprise Portal:
 
 1. In the Enterprise Portal, go to **Updates**.
@@ -79,8 +99,8 @@ To view instances in the Enterprise Portal:
 
    <table>
       <tr>
-         <th>Field</th>
-         <th>Description</th>
+         <th width="30%">Field</th>
+         <th width="70%">Description</th>
       </tr>
       <tr>
          <td>Instance ID</td>
@@ -112,6 +132,48 @@ To view instances in the Enterprise Portal:
       </tr>
    </table>
 
+### Create an Air Gap Instance Record
+
+Air gap instance records do not appear in the Enterprise Portal until the end customer creates an air gap instance record by either uploading a support bundle for that instance or manually entering instance information.
+
+:::note
+To create an air gap instance record in the Enterprise Portal, the customer license must have the **Helm CLI Air Gap Instructions (Helm CLI only)** or **Air Gap Installation Option (Replicated Installers only)** option enabled. For more information, see [Create and Manage Customers](/vendor/releases-creating-customer).
+:::
+
+#### Upload a support bundle for the air gap instance
+
+To create an air gap instance record by extracting instance details from a support bundle:
+
+1. On the **Update** page, under **Air gap instances**, click **Create air gap instance record > Upload support bundle**.
+
+   <img alt="create air gap instance button" src="/images/enterprise-portal-create-air-gap-instance.png" width="700px"/>
+
+   [View a larger version of this image](/images/enterprise-portal-create-air-gap-instance.png)
+
+1. In the **Extract instance info from a support bundle** dialog, upload the support bundle and click **Upload bundle**:    
+
+   <img alt="manually create air gap instance dialog" src="/images/enterprise-portal-extract-air-gap-instance-bundle.png" width="500px"/>
+
+   [View a larger version of this image](/images/enterprise-portal-extract-air-gap-instance-bundle.png)
+
+#### Manually create an air gap instance record
+
+To create an air gap instance record manually:
+
+1. On the **Update** page, under **Air gap instances**, click **Create air gap instance record > Enter information manually**.
+
+   <img alt="create air gap instance button" src="/images/enterprise-portal-create-air-gap-instance.png" width="700px"/>
+
+   [View a larger version of this image](/images/enterprise-portal-create-air-gap-instance.png)
+
+1. In the **Manually create air gap instance record** dialog, complete the fields and click **Create instance**.
+
+   <img alt="manually create air gap instance dialog" src="/images/enterprise-portal-manually-create-air-gap-instance.png" width="500px"/>
+
+   [View a larger version of this image](/images/enterprise-portal-manually-create-air-gap-instance.png)
+
+    
+
 ## View Release History
 
 To view the release history in the Enterprise Portal:
@@ -137,7 +199,7 @@ To manage licenses in the Enterprise Portal:
 
 This section includes information about how to manage users and service accounts in the Enterprise Portal.
 
-### Manage Users
+### Invite or Delete Users
 
 Customers can invite additional users to the portal and manage their access.
 
diff --git a/docs/vendor/helm-install-airgap.mdx b/docs/vendor/helm-install-airgap.mdx
@@ -34,7 +34,7 @@ Before you install, complete the following prerequisites:
 
 Helm air gap installation instructions are provided in either the Enterprise Portal or the Download Portal, depending on which is enabled for the customer.
 
-For more information about enabling the Enterprise Portal for a customer, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
+For more information about enabling the Enterprise Portal for a customer, see [Manage Customer Access to the Enterprise Portal](/vendor/enterprise-portal-invite).
 
 ### Enterprise Portal (Beta)
 
diff --git a/docs/vendor/replicated-onboarding.mdx b/docs/vendor/replicated-onboarding.mdx
@@ -441,7 +441,7 @@ After completing the main onboarding tasks, Replicated recommends that you also
 
 The Enterprise Portal is a customizable, web-based portal where your customers can view application install and update instructions, upload support bundles, view insights about their active and inactive instances, and more. The Enterprise Portal is the next generation of the Download Portal. For more information, see [About the Enteprise Portal](/vendor/enterprise-portal-about).
 
-The Enterprise Portal is Beta. You can enable access to the Enterprise Portal for all customers or on a per-customer basis. For more information, see [Manage Enterprise Portal Access](/vendor/enterprise-portal-invite).
+The Enterprise Portal is Beta. You can enable access to the Enterprise Portal for all customers or on a per-customer basis. For more information, see [Manage Customer Access to the Enterprise Portal](/vendor/enterprise-portal-invite).
 
 You can also customize the Enterprise Portal so that your customers have a consistent branding experience. For example, you can use a custom domain, add links and contact information, customize the look and feel of the UI, edit the content of invitation and notification emails, and more. For more information about customizing the Enterprise Portal, see [Customize the Enterprise Portal](/vendor/enterprise-portal-configure).
 
diff --git a/sidebars.js b/sidebars.js
@@ -183,6 +183,7 @@ const sidebars = {
         'vendor/enterprise-portal-configure',
         'vendor/enterprise-portal-invite',
         'vendor/enterprise-portal-self-serve-signup',
+        'vendor/enterprise-portal-access',
         'vendor/enterprise-portal-use',
       ],
     },
diff --git a/static/images/enterprise-portal-create-air-gap-instance.png b/static/images/enterprise-portal-create-air-gap-instance.png
diff --git a/static/images/enterprise-portal-extract-air-gap-instance-bundle.png b/static/images/enterprise-portal-extract-air-gap-instance-bundle.png
diff --git a/static/images/enterprise-portal-invitation-email.png b/static/images/enterprise-portal-invitation-email.png
diff --git a/static/images/enterprise-portal-manually-create-air-gap-instance.png b/static/images/enterprise-portal-manually-create-air-gap-instance.png
