Enterprise portal docs (draft)

docs/vendor/custom-domains-using.md

@@ -1,6 +1,6 @@
 # Use Custom Domains
 
-This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, and the Download Portal.
+This topic describes how to use the Replicated Vendor Portal to add and manage custom domains to alias the Replicated registry, the Replicated proxy registry, the Replicated app service, the Replicated Enterprise Portal and the Replicated Download Portal.
 
 For information about adding and managing custom domains with the Vendor API v3, see the [customHostnames](https://replicated-vendor-api.readme.io/reference/createcustomhostname) section in the Vendor API v3 documentation.
 

docs/vendor/custom-domains.md

@@ -16,6 +16,8 @@ You can configure custom domains for the following services:
 
 - **Replicated app service:** Upstream application YAML and metadata, including a license ID, are pulled from the app service. By default, this service uses the domain `replicated.app`. Replicated recommends using a CNAME such as `updates.{your app name}.com`. 
 
+- **Enterprise Portal:** The Enterprise Portal is a web-based portal that provides end customers with a centralized location for managing their installation, including finding install and upgrade instructions, managing their license, inviting and managing team members, collecting and uploading support bundles, and more. By default, the Enterprise Portal uses the domain **`[DOMAIN].replicated.com`**. Replicated recommending using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`.
+
 - **Download Portal:** The Download Portal can be used to share customer license files, air gap bundles, and so on. By default, the Download Portal uses the domain `get.replicated.com`. Replicated recommends using a CNAME such as `portal.{your app name}.com` or `enterprise.{your app name}.com`. 
 
 - **Replicated registry:** Images and Helm charts can be pulled from the Replicated registry. By default, this registry uses the domain `registry.replicated.com`. Replicated recommends using a CNAME such as `registry.{your app name}.com`.

docs/vendor/enterprise-portal-about.mdx

@@ -0,0 +1,33 @@
+# About the Enterprise Portal
+
+This topic provides an overview of the Replicated Enterprise Portal.
+
+## Overview
+
+The Enterprise Portal is a customizable, web-based portal. It provides a centralized location where your customers can find installation and update instructions, manage their team and service accounts, upload support bundles, and more.
+
+The following shows an example of the Enterprise Portal dashboard:
+
+![Enterprise Portal dashboard](/images/enterprise-portal-dashboard.png)
+
+[View a larger version of this image](/images/enterprise-portal-dashboard.png)
+
+For more information about how to log in to and use the Enterprise Portal, see [Access and Use the Enterprise Portal](enterprise-portal-use).
+
+### Comparison to the Download Portal
+
+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 like in the Download Portal, but also allows users to track available updates, manage their team and service accounts, view the status of their instances, 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.
+
+You can migrate existing customers from the Download Portal to the Enterprise Portal by enabling the Enterprise Portal for their license. For more information, see [Manage Enterprise Portal Access](enterprise-portal-invite).
+
+## About Customizing the Enterprise Portal
+
+You can customize the Enterprise Portal to use a custom domain, provide custom links and contact information, customize the look and feel of the Enterprise Portal, edit the content of invitation and notification emails, and more. This helps ensure that your customers have a consistent branding experience.
+
+For more information, see [Customize the Enterprise Portal](enterprise-portal-configure).
+
+## Limitations and Known Issues
+
+The Enterprise Portal has the following limitations and known issues:
+
+* Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance.

docs/vendor/enterprise-portal-configure.mdx

@@ -0,0 +1,104 @@
+# Customize the Enterprise Portal
+
+This topic describes how to customize the Enterprise Portal, including using a custom domain, changing the branding, editing the content of invitation and notification emails, and adding custom documentation.
+
+## Manage Enterprise Portal Settings
+
+You can edit the settings for the Enterprise Portal to use a custom domain, provide custom links and contact information, customize the look and feel of the Enterprise Portal, and more.
+
+To manage Enterprise Portal settings:
+
+1. In the Vendor Portal, go to **Enterprise Portal > Settings**.
+
+    ![Enterprise Portal settings page](/images/enterprise-portal-settings.png)
+
+    [View a larger version of this image](/images/enterprise-portal-settings.png)
+
+1. Edit the settings as desired:
+
+   <table>
+     <tr>
+       <th>Field</th>
+       <th>Description</th>
+     </tr>
+     <tr>
+       <td>URL</td>
+       <td>The URL where customers can access the Enterprise Portal. You can change the URL to use a custom domain. For information, see [Use Custom Domains](custom-domains-using).</td>
+     </tr>
+     <tr>
+       <td>Title</td>
+       <td>The title of the Enterprise Portal. The title is displayed at the top of each page in the Enterprise Portal and is also used in email notifications.</td>
+     </tr>
+     <tr>
+       <td>Page overview</td>
+       <td>An overview of the Enterprise Portal.</td>
+     </tr>
+     <tr>
+       <td>Support portal link</td>
+       <td>The URL for the portal that your customers can use to get support. This link is provided on the Enterprise Portal **Support** page.</td>
+     </tr>
+     <tr>
+       <td>Contact email</td>
+       <td>The email address that customers can use to contact you. This email address is provided on the Enterprise Portal **Support** page.</td>
+     </tr>
+     <tr>
+       <td>Logo</td>
+       <td>Upload a custom PNG logo for the Enterprise Portal. The minimum size for the logo is 160px by 160px.</td>
+     </tr>
+     <tr>
+       <td>Favicon</td>
+       <td>Upload a custom favicon for the Enterprise Portal. The favicon is displayed in the browser tab.</td>
+     </tr>
+     <tr>
+       <td>Background</td>
+       <td>Select or customize the background for the Enterprise Portal.</td>
+     </tr>
+     <tr>
+       <td>Colors</td>
+       <td>Set the primary and secondary colors for the Enterprise Portal.</td>
+     </tr>
+   </table>
+
+1. Click **Save**.
+
+## Configure Invitation and Notification Emails {#configure-customer-emails}
+
+You can customize the invitation and notification emails that are sent to your customers.
+
+To configure customer emails:
+
+1. In the Vendor Portal, go to **Enterprise Portal > Customer emails**.
+
+   ![Enterprise Portal customer emails page](/images/enterprise-portal-customer-emails.png)
+
+   [View a larger version of this image](/images/enterprise-portal-customer-emails.png)
+
+1. For **Email Sender Verification**, in **From email address**, add the email address that you want to use as the sender for all system notifications sent to your customers, then click **Continue**. Adding a sender address helps ensure that your emails are delivered and are not marked as spam.
+
+    After the domain is verified automatically, the email address is displayed under **Verified Sender Address**.
+1. For **Customer Emails**, customize the subject line and body of the emails that are sent to your customers for various system events.
+
+     ![Enterprise Portal edit emails pane](/images/enterprise-portal-customer-emails-edit.png)
+
+     [View a larger version of this image](/images/enterprise-portal-customer-emails-edit.png)
+
+## Customize Documentation
+
+The install and update 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.
+
+To customize documentation:
+
+1. In the Vendor Portal, go to **Enterprise Portal > Knowledge Base**.
+
+   ![Enterprise Portal knowledge base page](/images/enterprise-portal-knowledge-base.png)
+
+   [View a larger version of this image](/images/enterprise-portal-knowledge-base.png)
+
+1. In the panel on the left, select the installation type.
+
+1. Customize the documentation for the selected installation type as desired:
+    1. In the documentation links section, add a link to your installation documentation. The link is displayed on the Enterprise Portal **Install** page.
+    1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes.
+1. Click **Save changes**.

docs/vendor/enterprise-portal-invite.mdx

@@ -0,0 +1,35 @@
+# Manage Enterprise Portal Access
+
+This topic describes how to enable or disable customer access to the Enterprise Portal and how to invite users to the Enterprise Portal.
+
+For information about customizing the invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
+
+## Manage Customer 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.
+
+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:
+
+   * **Manage Enterprise Portal access for all customers**: Go to **Enterprise Portal > Access**. For **Portal access**, enable or disable the toggle to control if all customers have access to the Enterprise Portal or the Download Portal.
+
+   * **Manage Enterprise Portal access per customer**: Go to **Customers** and select the target customer. On the customer's page, go to **Manage 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.
+
+## Invite Users
+
+This section describes how to invite users to the Enterprise Portal using the Vendor Portal. Your customers can also invite users to the Enterprise Portal from the Enterprise Portal **Team settings** page. For more information, 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 where the new user is associated. See [Manage Customer 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_.
+
+1. In the Vendor Portal, go to either **Enterprise Portal > Access** or to **Customers > [Customer Name] > Manage Enterprise Portal Access**. Then, click **Invite user**.
+
+1. In the **Invite user** dialog, for **Customer**, select the customer from the dropdown where the new user is associated.
+
+1. For **Email**, enter the user's email address.
+
+1. Click **Send invite**.

docs/vendor/enterprise-portal-use.mdx

@@ -0,0 +1,134 @@
+# Access and Use the Enterprise Portal
+
+This topic describes how to access and use the Enterprise Portal.
+
+## Access the Enterprise Portal
+
+To access the Enterprise Portal for a customer:
+
+1. In the Vendor Portal, go to **Customers > [Customer Name] > Enterprise Portal Access**.
+
+1. Ensure that the **Enterprise Portal access** toggle is enabled.
+
+1. Do one of the following to log in to the Enterprise Portal:
+    * **Existing user**: Click **View customer's portal link**. 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 user's email address.
+    * **New user**: To log in to the Enterprise Portal as a new user, invite the user and then follow the login link provided in the invitation email. See [Invite Users to the Enterprise Portal](enterprise-portal-invite).
+
+## View Install and Update Instructions
+
+This section describes how to view install and update instructions in the Enterprise Portal.
+
+The install and update 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).
+
+### View Install Instructions
+
+To view install instructions in the Enterprise Portal:
+
+1. Log in to the Enterprise Portal and go to **Install**.
+
+1. On the panel on the left, select the installation type. The installation options available in the Enterprise Portal are based on the customer's license. For more information, see [Manage Install Types for a License](/vendor/licenses-install-types).
+
+1. Follow the instructions provided to install.
+
+    If you exit the Enterprise Portal before completing the installation, you can resume the installation process by clicking **Continue installation** on the **Install** page, as shown below:
+
+    ![Enterprise Portal continue installation button](/images/enterprise-portal-continue-install.png)
+
+    [View a larger version of this image](/images/enterprise-portal-continue-install.png)
+
+### View Update Instructions
+
+To view update instructions in the Enterprise Portal:
+
+1. Log in to the Enterprise Portal and go to **Update**.
+
+   For any online instances, the Enterprise Portal displays an **Update available** button when a new version is available.
+
+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
+
+Users can view their active and inactive instances in the Enterprise Portal, including the instance status and other details. 
+
+To view instances in the Enterprise Portal:
+
+1. In the Enterprise Portal, go to **Updates**.
+
+1. Under **Active Instances** view details about the active instances. Select **View inactive instances** to view details about inactive instances.
+
+## View Release History
+
+To view the release history in the Enterprise Portal:
+
+1. In the Enterprise Portal, go to **Release History**.
+
+1. In the **Version History** panel on the left, select a version to view details about the given release. 
+
+## View License Details
+
+Customers can view license information, including expiration dates and available features.
+
+To manage licenses in the Enterprise Portal:
+
+1. In the Enterprise Portal, go to **License**.
+
+1. Under **License Details**, view license information including the expiration date, status, associated release channels, custom license fields, and more.
+
+## Manage Team Settings
+
+This section includes information about how to manage users and service accounts in the Enterprise Portal.
+
+### Manage Users
+
+Customers can invite additional users to the portal and manage their access.
+
+To manage invite and manage users in the Enterprise Portal:
+
+1. In the Enterprise Portal, openthe user account dropdown in the top right of the page and select **Team settings**.
+
+1. Click **Users**.
+
+1. Manage users as desired:
+   * To invite a new user, click **Invite user**.
+   * To delete a user, find the target user in the table and open the menu. Select **Delete user**.
+
+### Manage Service Accounts
+
+To manage service accounts in the Enterprise Portal:
+
+1. In the Enterprise Portal, openthe user account dropdown in the top right of the page and select **Team settings**.
+
+1. Click **Service accounts**.
+
+1. Manage service accounts as desired:
+   * To create a new service account, click **Create Service Account**.
+   * To view a service account token, find the target service account in the table and click **View** under **Token**.
+   * The revoke a service account's token, find the target service account in the table and open the menu under **Actions**. Select **Revoke**.
+
+## Manage User Settings
+
+Each user can manage their settings in the Enterprise Portal, including enabling and disabling email notifications for various system events.
+
+To manage user settings in the Enterprise Portal:
+
+1. In the Enterprise Portal, open the user account dropdown in the top right of the page and select **User settings**.
+
+1. Edit the user settings as desired:
+   * Edit profile information
+   * Manage email notification preferences
+
+## Collect, Upload, and Manage Support Bundles
+
+End customers can use the portal to collect, upload, and manage support bundles.
+
+To manage support bundles in the Enterprise Portal:
+
+1. In the Enterprise Portal, go to **Support**.
+
+1. Manage support bundles as desired:
+
+   * For **Support Bundle Collection**, follow the instructions provided to collect a support bundle based on the environment.
+
+   * To upload a support bundle, click **Upload support bundle**.
+
+   * To view, download, or delete previous support bundles, select **Download** or **Delete** in the **Support Bundles** table.