Skip to content

Commit 16f2a75

Browse files
tiffany-mintlifyrpmccarterhahnbeelee
authored
added 'contact us' for auth docs (#423)
* added 'contact us' for auth docs * Update settings/authentication-personalization/authentication-setup/mintlify.mdx Co-authored-by: Ronan McCarter <[email protected]> * added a page for preview deployments * nits * fix broken link --------- Co-authored-by: Ronan McCarter <[email protected]> Co-authored-by: Hahnbee Lee <[email protected]>
1 parent c804c51 commit 16f2a75

File tree

5 files changed

+76
-27
lines changed

5 files changed

+76
-27
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/preview-deployments"
150151
]
151152
},
152153
{
Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,46 @@
11
---
2-
title: 'Mintlify Dashboard Handshake'
3-
description: 'Use the Mintlify Dashboard to authenticate users'
2+
title: "Mintlify Dashboard Handshake"
3+
description: "Use Mintlify to authenticate users"
44
---
55

66
<Info>
7-
This is the documentation for the Mintlify Dashboard **Authentication** Handshake. The Mintlify Dashboard Handshake is not available for Personalization.
7+
The Mintlify Dashboard Handshake is available only for Authentication, *not*
8+
Personalization.
89
</Info>
910

10-
If your documentation readers are also your documentation editors, you can allow Mintlify to manage access to your documentation. Anyone that can access
11-
your dashboard will automatically be able to access your documentation.
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.
1212

13-
## Implementation
13+
This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments.
1414

15-
<Steps>
16-
<Step title="Configure your Authentication settings">
17-
Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and enable the Mintlify Dashboard Handshake.
18-
</Step>
19-
<Step title="Add users">
20-
Ensure that any users that should be able to view your documentation have been added as users in your
21-
[Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
22-
</Step>
23-
</Steps>
15+
<Note>
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.
19+
</Note>
2420

25-
## Example
21+
### Example
2622

2723
I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs
2824
to be internal, and the people that will be viewing my docs are the same people that
2925
contribute to my docs.
3026

31-
To set up authentication with Mintlify, I go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
27+
To set up authentication with Mintlify, I can go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication)
3228
and enable Authentication with the Mintlify Dashboard Handshake.
3329

34-
I then ensure that anyone that should be able to read the docs has been added as a user in
30+
I can then ensure that anyone that should be able to read the docs has been added as a user in
3531
my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members).
32+
33+
## Implementation
34+
35+
<Steps>
36+
<Step title="Configure your Authentication settings">
37+
Go to your [Mintlify dashboard
38+
settings](https://dashboard.mintlify.com/products/authentication) and select
39+
the Mintlify Auth Handshake.
40+
</Step>
41+
<Step title="Add users">
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).
45+
</Step>
46+
</Steps>

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>
Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,30 @@
11
---
2-
title: 'Authentication'
3-
description: 'Features available with the Authentication product'
2+
title: "Authentication"
3+
description: "Guarantee privacy of your docs by authenticating users"
44
---
55

66
<Note>
7-
Authentication is an enterprise feature. To get access, [contact sales](mailto:[email protected]).
7+
Authentication is an enterprise feature. To get access, [contact
8+
sales](mailto:[email protected]).
89
</Note>
910

10-
As the name suggests, Authentication offers full privacy for all of your
11-
documentation content. This includes all of the following:
11+
Authentication offers full privacy for all of your
12+
documentation content by requiring users to authenticate before viewing any content, such as:
1213

1314
- Documentation page content
1415
- Images used in documentation pages
1516
- Search results
1617
- AI chat interactions
1718

18-
Authentication can be thought of as Personalization + privacy. In addition
19+
You can authenticate users through handshake methods such as:
20+
21+
- [Password](./authentication-setup/password)
22+
- [JWT](./authentication-setup/jwt)
23+
- [OAuth](./authentication-setup/oauth)
24+
- [Mintlify dashboard](./authentication-setup/mintlify)
25+
26+
Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition
1927
to securing your documentation content, all features that are available via
20-
Personalization are also available via Authentication. For more information
21-
about the features of Personalization, [visit our docs on Personalization](./personalization).
28+
Personalization are also available via Authentication.
29+
30+
Check out our docs for more info on [choosing Authentication vs Personalization](./authentication-vs-personalization).

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]).

0 commit comments

Comments
 (0)