Skip to content

Commit dd6e28a

Browse files
authored
Merge pull request #3588 from replicatedhq/EP-doc-fixes
Enterprise Portal: add docs for self-serve sign-up and fix some outdated content
2 parents 0d4fa31 + 419828d commit dd6e28a

8 files changed

+62
-4
lines changed

docs/vendor/enterprise-portal-about.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For information about using the Enterprise Portal, see [Access and Use the Enter
3333

3434
* The Enterprise Portal is Beta. The features and functionality of the Enterprise Portal are subject to change.
3535

36-
* Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance. For more information, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_.
36+
* 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. For more information, see [View Active and Inactive Instances](/vendor/enterprise-portal-use#view-active-and-inactive-instances) in _Access and Use the Enterprise Portal_.
3737

3838
* Installation and upgrade instructions are available only for Embedded Cluster and Helm installations. The Enterprise Portal does not provide instructions for installing and upgrading with KOTS in existing clusters.
3939

@@ -53,6 +53,8 @@ For more information about customizing the Enterprise Portal, see [Customize the
5353

5454
For information about how to set a custom domain for the Enterprise Portal, see [Use Custom Domains](/vendor/custom-domains-using).
5555

56+
You can enable and disable access to the Enterprise Portal for all customers, or on a per-customer basis. For more information about how to enable access, see [Manage Customer Access](/vendor/enterprise-portal-invite#manage-ep-access).
57+
5658
## About Instance Reporting with the Enterprise Portal
5759

5860
This section describes the instance reporting functionality of the Enterprise Portal.

docs/vendor/enterprise-portal-configure.mdx

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ To configure customer emails:
8686

8787
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).
8888

89-
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.
89+
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.
9090

9191
To customize documentation:
9292

@@ -101,4 +101,9 @@ To customize documentation:
101101
1. Customize the documentation for the selected installation type as desired:
102102
1. In the documentation links section, add a link to your installation documentation. The link is displayed on the Enterprise Portal **Install** page.
103103
1. In the documentation content section, add pre- and post-installation instructions in markdown format. Click **Preview** to see a preview of your changes.
104+
105+
:::note
106+
By default, these same instructions are shown for all release channels. To add channel-specific instructions, go to the **Channel customizations** section.
107+
:::
108+
104109
1. Click **Save changes**.
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Self-Service Enterprise Portal Sign-Ups (Beta)
2+
3+
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.
4+
5+
For information about customizing the Trial Signup invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
6+
7+
## Overview
8+
9+
You can enable self-service sign-ups through the Enterprise Portal for your application. When self-service sign-ups are enabled, current and potential customers can access your application by signing up for a trial or community license. All licenses issued through self-service sign-ups are automatically configured based on the default license policy that you configure in the Vendor Portal.
10+
11+
## Enable Self-Service Sign-Ups {#enable-self-service-signup}
12+
13+
To enable Enterprise Portal self-service sign-ups:
14+
15+
1. In the Vendor Portal, go to **Enterprise Portal > Self Serve Signup**.
16+
17+
![Self-Service Sign-Up Configuration Screen](/images/self-serve-configure.png)
18+
19+
[View a larger version of this image](/images/self-serve-configure.png)
20+
21+
1. (Optional) For **Terms and Conditions URL**, enter a URL to the terms and conditions that the user must acknowlwedge before proceeding with signup.
22+
23+
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.
24+
25+
1. Click **Save**.
26+
27+
## Share Your Sign-up URL {#share-trial-url}
28+
29+
Each application has a dedicated sign-up URL where users can access the self-servive sign up. When a new user naviagtes to the sign-up page and clicks **Create account**, they receive an email with a 12-digit verification code. The following shows an example of a self-service sign-up page for an application:
30+
31+
<img alt="Self-Service Sign-Up Interaction" src="/images/self-serve-signup-screen.png" width="400px"/>
32+
33+
[View a larger version of this image](/images/self-serve-signup-screen.png)
34+
35+
To get the sign-up URL for your application:
36+
1. In the Vendor Portal, go to **Enterprise Portal > Self Serve Signup**.
37+
1. Under **Enable self-service sign-ups**, copy the **Sign-Up URL**.
38+
39+
## View Pending Trials {#pending-user}
40+
41+
When users request access to your application through a self-service sign-up, they are added to a list of **Pending Trials**. After the user confirms their account through the automated confirmation email, an active customer record is created for the user on the **Customers** page.
42+
43+
To view pending trials:
44+
45+
1. In the Vendor Portal, go to **Enterprise Portal > Self Serve Signup**.
46+
1. Under **Pending Trials**, review details about any pending self-service sign-ups, including the user's email address, company, sign-up date and time, and more.
47+
48+
![Pending Trials List View](/images/pending-trial-user.png)
49+
50+
[View a larger version of this image](/images/pending-trial-user.png)

docs/vendor/enterprise-portal-use.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To view update instructions in the Enterprise Portal:
6363
Users can view their active and inactive instances in the Enterprise Portal, including the instance status and other details.
6464

6565
:::note
66-
Air gap instance records do not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance.
66+
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.
6767
:::
6868

6969
To view instances in the Enterprise Portal:
@@ -206,4 +206,4 @@ To manage support bundles in the Enterprise Portal:
206206

207207
* To upload a support bundle, click **Upload support bundle**.
208208

209-
* To view, download, or delete previous support bundles, select **Download** or **Delete** in the **Support Bundles** table.
209+
* To view, download, or delete previous support bundles, select **Download** or **Delete** in the **Support Bundles** table.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,7 @@ const sidebars = {
181181
'vendor/enterprise-portal-about',
182182
'vendor/enterprise-portal-configure',
183183
'vendor/enterprise-portal-invite',
184+
'vendor/enterprise-portal-self-serve-signup',
184185
'vendor/enterprise-portal-use',
185186
],
186187
},
86.5 KB
Loading
249 KB
Loading
35.8 KB
Loading

0 commit comments

Comments
 (0)