Skip to content

Commit be82cc7

Browse files
added a page for preview deployments
1 parent 8f8d815 commit be82cc7

File tree

4 files changed

+33
-11
lines changed

4 files changed

+33
-11
lines changed

mint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,8 @@
146146
"settings/versioning",
147147
"settings/add-members",
148148
"settings/github",
149-
"settings/gitlab"
149+
"settings/gitlab",
150+
"settings/previewdeployments"
150151
]
151152
},
152153
{

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

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ title: 'Mintlify Dashboard Handshake'
33
description: 'Use Mintlify to authenticate users'
44
---
55

6-
<Note>
7-
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.
8-
</Note>
9-
10-
11-
You can use Mintlify to authenticate and manage access to your documentation. Anyone that can access
12-
your dashboard will automatically be able to see your documentation.
13-
14-
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.
15-
166
<Info>
177
The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization.
188
</Info>
199

10+
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+
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.
13+
14+
<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+
</Note>
17+
2018
### Example
2119

2220
I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ If you don't have strict security requirements, or you don't want to manage a
1111
database of documentation readers, you can use a set of shared passwords to
1212
protect your docs.
1313

14+
<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+
</Note>
17+
1418
## Implementation
1519

1620
<Steps>

settings/previewdeployments.mdx

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
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 Growth and Enterprise plans. Please <a href="mailto:[email protected]">contact our sales team</a> for more information.
9+
</Info>
10+
11+
Preview Deployments allow you to preview changes to your app in a live deployment without merging those changes to your Git project's production branch.
12+
13+
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 body of the PR. This URL will always reflect the latest deployment changes.
14+
15+
## Sharing Preview Deployments
16+
17+
After generated a preview URL, you can share that link with anybody for them to view.
18+
19+
If you'd like to restrict access, you can use [authentication via Mintlify handshake](./authentication-personalization/authentication-setup/mintlify) to make preview deployments private by default. When using this authentication method, only Mintlify authenticated users will be able to access your Preview Deployments.

0 commit comments

Comments
 (0)