Skip to content

Commit 3e957ad

Browse files
paigecalvertpaigecalvert
committed
Enterprise portal docs (draft)
1 parent e2739ff commit 3e957ad

File tree

5 files changed

+213
-0
lines changed

5 files changed

+213
-0
lines changed

‎docs/vendor/enterprise-portal-about.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# About the Enterprise Portal
2+
3+
This topic provides an overview of the Enterprise Portal.
4+
5+
## Overview
6+
7+
The Enterprise Portal is a web-based portal that provides a centralized location where your end customers can find installation and upgrade instructions, manage their license, manage team memebers and service accounts, collect and upload support bundles, and more.
8+
9+
## About Using the Enterprise Portal
10+
11+
Key features include:
12+
13+
* Customer-specific, customizable installation and upgrade instructions that are automatically generated based on the customer's license details. See (link to page on license install types)
14+
*
15+
* ...
16+
17+
## About Configuring the Enterprise Portal
18+
19+
* License type controls the install/upgrade instructions that are shown to the customer
20+
* Customizable branding and documentation
21+
* Invitation and notification emails
22+
* etc
23+
24+
For more information, see [Customize the Enterprise Portal](enterprise-portal-configure).
25+
26+
## About Customer Insights and Telemetry
27+
28+
Just-in-Time Service Account Generation:
29+
* The system generates a unique service account.
30+
* This service account is used to track installation attempts and control access to downloads. This is viewable on the customer/reporting detail page for each customer
31+
32+
The vendor is able to see the progress of each install attempt on the reporting tab for each license.
33+
34+
(Link to the docs page on viewing customer insights and telemetry)
35+
36+
## Limitations and Known Issues
37+
38+
The Enterprise Portal has the following limitations and known issues:
39+
40+
* Air gap instance records does not appear in the Enterprise Portal until the vendor uploads a support bundle for that instance.
41+
42+
* other

‎docs/vendor/enterprise-portal-configure.mdx‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Customize the Enterprise Portal
2+
3+
This topic describes how to customize the Enterprise Portal, including branding, invitation and notification emails, and documentation.
4+
5+
## Configure a Custom Domain
6+
7+
Vendors can configure a custom domain for the Enterprise Portal.
8+
9+
For information, see [Use Custom Domains](custom-domains-using).
10+
11+
## Configure Custom Branding
12+
Vendors can customize the portal's appearance by uploading their logo, selecting color schemes, and applying other branding elements.
13+
This ensures a consistent brand experience for end customers.
14+
15+
To configure branding for the Enterprise Portal:
16+
17+
1. Step 1
18+
1. Step 2
19+
1. Step 3
20+
21+
## Configure Invitation and Notification Emails
22+
23+
Vendors can configure email delegation and DMARC settings to send invitation and notification emails from their own domain.
24+
This allows for greater control over email deliverability and branding.
25+
26+
Vendors will be able to customize the templates for the emails using a templating language like Jinja.
27+
28+
To configure email delegation and DMARC settings:
29+
30+
1. Step 1
31+
1. Step 2
32+
1. Step 3
33+
34+
## Configure Documentation
35+
36+
Vendors can customize their pre & post install instructions with markdown.
37+
38+
To configure documentation:
39+
40+
1. Step 1
41+
1. Step 2
42+
1. Step 3

‎docs/vendor/enterprise-portal-invite.mdx‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Invite Customers to the Enterprise Portal
2+
3+
This topic describes how to send invitations to your customers with their unique access code to the Enterprise Portal.
4+
5+
For information about customizing the invitation email, see [Customize the Enterprise Portal](enterprise-portal-configure).
6+
7+
## Enable the Enterprise Portal for a Customer
8+
9+
Access to the Enterprise Portal is enabled on a per-customer basis.
10+
11+
To enable the Enterprise Portal for a customer:
12+
13+
1. Visit a customer detail page.
14+
15+
1. Toggle on the enterprise portal for the customer license (all other licenses will remain on the Download Portal).
16+
17+
## Invite Customers
18+
19+
To invite users to the Enterprise Portal:
20+
21+
1. Enable the Enterprise Portal for the customer that you want to invite. See above.
22+
23+
1. Enter the email addresses for the customers you want to invite and assign them to specific customer accounts.
24+
25+
1. Click Invite(?)
26+
27+
The system sends an invitation email with a unique access code. End customers access the portal by entering their email address and the provided access code. The system verifies the code and grants access to the customer's designated portal.

‎docs/vendor/enterprise-portal-use.mdx‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Access and Use the Enterprise Portal
2+
3+
This topic describes how to access and use the Enterprise Portal.
4+
5+
## Access the Enterprise Portal
6+
7+
### Access from the Vendor Portal
8+
9+
To access the Enterprise Portal for a customer from the Vendor Portal:
10+
11+
1. Visit the customer detail page.
12+
13+
1. Click...
14+
15+
### Access From the Invitation Email
16+
17+
To access the Enterprise Portal from an invitation email:
18+
19+
1. Create a test customer.
20+
21+
1. Send the invitation email to the test customer. See [Invite Users to the Enterprise Portal](enterprise-portal-invite).
22+
23+
1. Click the link in the invitation email.
24+
25+
1. Enter the access code provided in the email.
26+
27+
1. Click Login.
28+
29+
## View Installation Instructions
30+
31+
To view installation instructions in the Enterprise Portal:
32+
33+
1. Log in to the Enterprise Portal. See above.
34+
35+
1. In the Enterprise Portal, go to...
36+
37+
1. If options are available, select the type of installation
38+
39+
1. Follow the instructions provided to install.
40+
41+
The system tracks each step of the installation process, providing real-time feedback to the customer.
42+
43+
## View Upgrade Instructions
44+
45+
To view upgrade instructions in the Enterprise Portal:
46+
47+
1. Log in to the Enterprise Portal. See above.
48+
49+
1. In the Enterprise Portal, go to...
50+
51+
## Manage Licnses
52+
53+
Customers can view license information, including expiration dates and available features.
54+
55+
To manage licenses in the Enterprise Portal:
56+
57+
1. Log in to the Enterprise Portal. See above.
58+
59+
1. In the Enterprise Portal, go to...
60+
61+
## Manage Teams
62+
63+
### Manage Team Members
64+
65+
Customers can invite additional team members to the portal and manage their access.
66+
67+
To manage invite and manage team members in the Enterprise Portal:
68+
69+
1. Log in to the Enterprise Portal. See above.
70+
71+
1. In the Enterprise Portal, go to...
72+
73+
### Manage Service Accounts
74+
75+
To manage service accounts in the Enterprise Portal:
76+
77+
1. Log in to the Enterprise Portal. See above.
78+
79+
1. In the Enterprise Portal, go to...
80+
81+
## Collect and Upload Support Bundles
82+
83+
End customers can use the portal to collect and upload support bundles.
84+
The portal provides instructions for collecting support bundles in different environments.
85+
86+
End customers can view and download their uploaded support bundles through the portal.
87+
88+
To collect and upload support bundles in the Enterprise Portal:
89+
90+
1. Log in to the Enterprise Portal. See above.
91+
92+
1. In the Enterprise Portal, go to...

‎sidebars.js‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,16 @@ const sidebars = {
212212
},
213213
],
214214
},
215+
{
216+
type: 'category',
217+
label: 'Enterprise Portal',
218+
items: [
219+
'vendor/enterprise-portal-about',
220+
'vendor/enterprise-portal-configure',
221+
'vendor/enterprise-portal-invite',
222+
'vendor/enterprise-portal-use',
223+
],
224+
},
215225
{
216226
type: 'category',
217227
label: 'Compatibility Matrix',

0 commit comments

Comments
 (0)