Skip to content

Commit 025ca00

Browse files
committed
nits
1 parent be82cc7 commit 025ca00

File tree

4 files changed

+38
-29
lines changed

4 files changed

+38
-29
lines changed

mint.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@
147147
"settings/add-members",
148148
"settings/github",
149149
"settings/gitlab",
150-
"settings/previewdeployments"
150+
"settings/preview-deployments"
151151
]
152152
},
153153
{

settings/authentication-personalization/authentication-setup/mintlify.mdx

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,21 @@
11
---
2-
title: 'Mintlify Dashboard Handshake'
3-
description: 'Use Mintlify to authenticate users'
2+
title: "Mintlify Dashboard Handshake"
3+
description: "Use Mintlify to authenticate users"
44
---
55

66
<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.
89
</Info>
910

1011
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.
1112

1213
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.
1314

1415
<Note>
15-
Authentication is available only by request. Please <a href="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+
<a href="mailto:[email protected]">contact sales</a> for access. After we've
18+
enabled access, you can follow the implementation instructions.
1619
</Note>
1720

1821
### Example
@@ -31,12 +34,13 @@ my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organiz
3134

3235
<Steps>
3336
<Step title="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.
3540
</Step>
3641
<Step title="Add users">
37-
Ensure that any users that should be able to view your documentation have been added as users in your
38-
[Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
42+
Ensure that any users that should be able to view your documentation have
43+
been added as users in your [Mintlify dashboard
44+
settings](https://dashboard.mintlify.com/settings/organization/members).
3945
</Step>
4046
</Steps>
41-
42-

settings/preview-deployments.mdx

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: "Preview Deployments"
3+
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+
<a href="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]).

settings/previewdeployments.mdx

Lines changed: 0 additions & 19 deletions
This file was deleted.

0 commit comments

Comments
 (0)