You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: settings/authentication-personalization/authentication-setup/mintlify.mdx
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,21 @@
1
1
---
2
-
title: 'Mintlify Dashboard Handshake'
3
-
description: 'Use Mintlify to authenticate users'
2
+
title: "Mintlify Dashboard Handshake"
3
+
description: "Use Mintlify to authenticate users"
4
4
---
5
5
6
6
<Info>
7
-
The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization.
7
+
The Mintlify Dashboard Handshake is available only for Authentication, *not*
8
+
Personalization.
8
9
</Info>
9
10
10
11
You can use Mintlify to authenticate and manage access to your documentation. Anyone that can access your dashboard will automatically be able to see your documentation.
11
12
12
13
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.
13
14
14
15
<Note>
15
-
Authentication is available only by request. Please <ahref="mailto:[email protected]">contact our sales team</a> for access. After we've enabled access, you can follow the implementation instructions.
16
+
Authentication is available only by request. Please{""}
17
+
<ahref="mailto:[email protected]">contact sales</a> for access. After we've
18
+
enabled access, you can follow the implementation instructions.
16
19
</Note>
17
20
18
21
### Example
@@ -31,12 +34,13 @@ my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organiz
31
34
32
35
<Steps>
33
36
<Steptitle="Configure your Authentication settings">
34
-
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and select the Mintlify Auth Handshake.
37
+
Go to your [Mintlify dashboard
38
+
settings](https://dashboard.mintlify.com/products/authentication) and select
39
+
the Mintlify Auth Handshake.
35
40
</Step>
36
41
<Steptitle="Add users">
37
-
Ensure that any users that should be able to view your documentation have been added as users in your
description: "Preview changes to your docs in a live deployment"
4
+
icon: "street-view"
5
+
---
6
+
7
+
<Info>
8
+
Preview Deployments are available on the Growth and Enterprise plans. Please{""}
9
+
<ahref="mailto:[email protected]">contact sales</a> for more information.
10
+
</Info>
11
+
12
+
Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch.
13
+
14
+
If you have created a pull or merge request when using Git, the generated preview URL will be available as a comment from the Mintlify bot in the PR. This URL will always reflect the latest deployment changes.
15
+
16
+
## Sharing Preview Deployments
17
+
18
+
After generating a preview URL, you can share that link with anybody for them to view.
19
+
20
+
### Authenticated Preview Deployments
21
+
22
+
If you'd like to restrict access to your Preview Deployments, you can set up preview deployment authentication. When using this authentication method, only Mintlify authenticated users will be able to access your Preview Deployments.
23
+
24
+
To set up preview deployment authentication, please [contact sales](mailto:[email protected]).
0 commit comments