From b4055d07611c416f8705b7331964149a645c5c29 Mon Sep 17 00:00:00 2001 From: Tiffany Date: Fri, 13 Dec 2024 12:49:40 -0800 Subject: [PATCH 1/5] added 'contact us' for auth docs --- .../authentication-setup/mintlify.mdx | 39 ++++++++++++------- .../authentication.mdx | 21 +++++++--- 2 files changed, 39 insertions(+), 21 deletions(-) diff --git a/settings/authentication-personalization/authentication-setup/mintlify.mdx b/settings/authentication-personalization/authentication-setup/mintlify.mdx index 0ed517c96..dc452c06a 100644 --- a/settings/authentication-personalization/authentication-setup/mintlify.mdx +++ b/settings/authentication-personalization/authentication-setup/mintlify.mdx @@ -1,20 +1,39 @@ --- title: 'Mintlify Dashboard Handshake' -description: 'Use the Mintlify Dashboard to authenticate users' +description: 'Use Mintlify to authenticate users' --- + +Mintlify Dashboard Handshake is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. + + + +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. + +This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. + - This is the documentation for the Mintlify Dashboard **Authentication** Handshake. The Mintlify Dashboard Handshake is not available for Personalization. + The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization. -If your documentation readers are also your documentation editors, you can allow Mintlify to manage access to your documentation. Anyone that can access -your dashboard will automatically be able to access your documentation. +### Example + +I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs +to be internal, and the people that will be viewing my docs are the same people that +contribute to my docs. + +To set up authentication with Mintlify, I can go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) +and enable Authentication with the Mintlify Dashboard Handshake. + +I can then ensure that anyone that should be able to read the docs has been added as a user in +my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members). ## Implementation - Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and enable the Mintlify Dashboard Handshake. + Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and select the Mintlify Auth Handshake. Ensure that any users that should be able to view your documentation have been added as users in your @@ -22,14 +41,4 @@ your dashboard will automatically be able to access your documentation. -## Example -I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs -to be internal, and the people that will be viewing my docs are the same people that -contribute to my docs. - -To set up authentication with Mintlify, I go to my [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) -and enable Authentication with the Mintlify Dashboard Handshake. - -I then ensure that anyone that should be able to read the docs has been added as a user in -my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members). diff --git a/settings/authentication-personalization/authentication.mdx b/settings/authentication-personalization/authentication.mdx index b645e1fb5..366458df5 100644 --- a/settings/authentication-personalization/authentication.mdx +++ b/settings/authentication-personalization/authentication.mdx @@ -1,21 +1,30 @@ --- title: 'Authentication' -description: 'Features available with the Authentication product' +description: 'Guarantee privacy of your docs by authenticating users' --- Authentication is an enterprise feature. To get access, [contact sales](mailto:sales@mintlify.com). -As the name suggests, Authentication offers full privacy for all of your -documentation content. This includes all of the following: +Authentication offers full privacy for all of your +documentation content by requiring users to authenticate before viewing any content, such as: - Documentation page content - Images used in documentation pages - Search results - AI chat interactions -Authentication can be thought of as Personalization + privacy. In addition +You can authenticate users through handshake methods such as: + +- [Password](./authentication-setup/password) +- [JWT](./authentication-setup/jwt) +- [OAuth](./authentication-setup/oauth) +- [Mintlify dashboard](./authentication-setup/mintlify) + + +Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition to securing your documentation content, all features that are available via -Personalization are also available via Authentication. For more information -about the features of Personalization, [visit our docs on Personalization](./personalization). +Personalization are also available via Authentication. + +Check out our docs for more info on [choosing Authentication vs Personalization]((./authentication-vs-personalization)). From 8f8d81524801fe1948371148e84f8f666f7ba287 Mon Sep 17 00:00:00 2001 From: tiffany-mintlify Date: Fri, 13 Dec 2024 14:04:25 -0800 Subject: [PATCH 2/5] Update settings/authentication-personalization/authentication-setup/mintlify.mdx Co-authored-by: Ronan McCarter <63772591+rpmccarter@users.noreply.github.com> --- .../authentication-setup/mintlify.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings/authentication-personalization/authentication-setup/mintlify.mdx b/settings/authentication-personalization/authentication-setup/mintlify.mdx index dc452c06a..046c88c95 100644 --- a/settings/authentication-personalization/authentication-setup/mintlify.mdx +++ b/settings/authentication-personalization/authentication-setup/mintlify.mdx @@ -4,7 +4,7 @@ description: 'Use Mintlify to authenticate users' --- -Mintlify Dashboard Handshake is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. +Authentication is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. From be82cc7852ac83bc329b7f24fe3c713b7999366b Mon Sep 17 00:00:00 2001 From: Tiffany Date: Fri, 13 Dec 2024 17:08:39 -0800 Subject: [PATCH 3/5] added a page for preview deployments --- mint.json | 3 ++- .../authentication-setup/mintlify.mdx | 18 ++++++++---------- .../authentication-setup/password.mdx | 4 ++++ settings/previewdeployments.mdx | 19 +++++++++++++++++++ 4 files changed, 33 insertions(+), 11 deletions(-) create mode 100644 settings/previewdeployments.mdx diff --git a/mint.json b/mint.json index 59a4fd2d8..0dc76db1b 100644 --- a/mint.json +++ b/mint.json @@ -146,7 +146,8 @@ "settings/versioning", "settings/add-members", "settings/github", - "settings/gitlab" + "settings/gitlab", + "settings/previewdeployments" ] }, { diff --git a/settings/authentication-personalization/authentication-setup/mintlify.mdx b/settings/authentication-personalization/authentication-setup/mintlify.mdx index 046c88c95..15e30adc1 100644 --- a/settings/authentication-personalization/authentication-setup/mintlify.mdx +++ b/settings/authentication-personalization/authentication-setup/mintlify.mdx @@ -3,20 +3,18 @@ title: 'Mintlify Dashboard Handshake' description: 'Use Mintlify to authenticate users' --- - -Authentication is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. - - - -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. - -This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. - The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization. +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. + +This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. + + +Authentication is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. + + ### Example I want to set up authentication for my docs hosted at `docs.foo.com`. I want my docs diff --git a/settings/authentication-personalization/authentication-setup/password.mdx b/settings/authentication-personalization/authentication-setup/password.mdx index 2ce275cc8..ec40391e6 100644 --- a/settings/authentication-personalization/authentication-setup/password.mdx +++ b/settings/authentication-personalization/authentication-setup/password.mdx @@ -11,6 +11,10 @@ If you don't have strict security requirements, or you don't want to manage a database of documentation readers, you can use a set of shared passwords to protect your docs. + +Authentication is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. + + ## Implementation diff --git a/settings/previewdeployments.mdx b/settings/previewdeployments.mdx new file mode 100644 index 000000000..3971090a1 --- /dev/null +++ b/settings/previewdeployments.mdx @@ -0,0 +1,19 @@ +--- +title: "Preview Deployments" +description: "Preview changes to your docs in a live deployment" +icon: "street-view" +--- + + +Preview Deployments are available on Growth and Enterprise plans. Please contact our sales team for more information. + + +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. + +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. + +## Sharing Preview Deployments + +After generated a preview URL, you can share that link with anybody for them to view. + +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. From 025ca00e15c03336da42fadbe490d8739fd6a8a3 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 16 Dec 2024 11:08:24 -0800 Subject: [PATCH 4/5] nits --- mint.json | 2 +- .../authentication-setup/mintlify.mdx | 22 ++++++++++------- settings/preview-deployments.mdx | 24 +++++++++++++++++++ settings/previewdeployments.mdx | 19 --------------- 4 files changed, 38 insertions(+), 29 deletions(-) create mode 100644 settings/preview-deployments.mdx delete mode 100644 settings/previewdeployments.mdx diff --git a/mint.json b/mint.json index 0dc76db1b..8b664f1d9 100644 --- a/mint.json +++ b/mint.json @@ -147,7 +147,7 @@ "settings/add-members", "settings/github", "settings/gitlab", - "settings/previewdeployments" + "settings/preview-deployments" ] }, { diff --git a/settings/authentication-personalization/authentication-setup/mintlify.mdx b/settings/authentication-personalization/authentication-setup/mintlify.mdx index 15e30adc1..7616e722b 100644 --- a/settings/authentication-personalization/authentication-setup/mintlify.mdx +++ b/settings/authentication-personalization/authentication-setup/mintlify.mdx @@ -1,10 +1,11 @@ --- -title: 'Mintlify Dashboard Handshake' -description: 'Use Mintlify to authenticate users' +title: "Mintlify Dashboard Handshake" +description: "Use Mintlify to authenticate users" --- - The Mintlify Dashboard Handshake is available only for Authentication, *not* Personalization. + The Mintlify Dashboard Handshake is available only for Authentication, *not* + Personalization. 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. @@ -12,7 +13,9 @@ You can use Mintlify to authenticate and manage access to your documentation. An This handshake method also enables private preview deployments, so that only Mintlify authenticated users will be able to access your preview deployments. -Authentication is available only by request. Please contact our sales team for access. After we've enabled access, you can follow the implementation instructions. + Authentication is available only by request. Please{" "} + contact sales for access. After we've + enabled access, you can follow the implementation instructions. ### Example @@ -31,12 +34,13 @@ my [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organiz - Go to your [Mintlify dashboard settings](https://dashboard.mintlify.com/products/authentication) and select the Mintlify Auth Handshake. + Go to your [Mintlify dashboard + settings](https://dashboard.mintlify.com/products/authentication) and select + the Mintlify Auth Handshake. - Ensure that any users that should be able to view your documentation have been added as users in your - [Mintlify dashboard settings](https://dashboard.mintlify.com/settings/organization/members). + Ensure that any users that should be able to view your documentation have + been added as users in your [Mintlify dashboard + settings](https://dashboard.mintlify.com/settings/organization/members). - - diff --git a/settings/preview-deployments.mdx b/settings/preview-deployments.mdx new file mode 100644 index 000000000..b12296dab --- /dev/null +++ b/settings/preview-deployments.mdx @@ -0,0 +1,24 @@ +--- +title: "Preview Deployments" +description: "Preview changes to your docs in a live deployment" +icon: "street-view" +--- + + + Preview Deployments are available on the Growth and Enterprise plans. Please{" "} + contact sales for more information. + + +Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch. + +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. + +## Sharing Preview Deployments + +After generating a preview URL, you can share that link with anybody for them to view. + +### Authenticated Preview Deployments + +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. + +To set up preview deployment authentication, please [contact sales](mailto:sales@mintlify.com). diff --git a/settings/previewdeployments.mdx b/settings/previewdeployments.mdx deleted file mode 100644 index 3971090a1..000000000 --- a/settings/previewdeployments.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Preview Deployments" -description: "Preview changes to your docs in a live deployment" -icon: "street-view" ---- - - -Preview Deployments are available on Growth and Enterprise plans. Please contact our sales team for more information. - - -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. - -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. - -## Sharing Preview Deployments - -After generated a preview URL, you can share that link with anybody for them to view. - -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. From d96defd2a1495ea19a5119f9d9ce15fbf08768d8 Mon Sep 17 00:00:00 2001 From: Hahnbee Lee <55263191+hahnbeelee@users.noreply.github.com> Date: Mon, 16 Dec 2024 11:17:41 -0800 Subject: [PATCH 5/5] fix broken link --- .../authentication.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/settings/authentication-personalization/authentication.mdx b/settings/authentication-personalization/authentication.mdx index 366458df5..b0fa7f62d 100644 --- a/settings/authentication-personalization/authentication.mdx +++ b/settings/authentication-personalization/authentication.mdx @@ -1,10 +1,11 @@ --- -title: 'Authentication' -description: 'Guarantee privacy of your docs by authenticating users' +title: "Authentication" +description: "Guarantee privacy of your docs by authenticating users" --- - Authentication is an enterprise feature. To get access, [contact sales](mailto:sales@mintlify.com). + Authentication is an enterprise feature. To get access, [contact + sales](mailto:sales@mintlify.com). Authentication offers full privacy for all of your @@ -22,9 +23,8 @@ You can authenticate users through handshake methods such as: - [OAuth](./authentication-setup/oauth) - [Mintlify dashboard](./authentication-setup/mintlify) - Authentication is similar to our [Personalization](./personalization) offering, but with guaranteed privacy. In addition to securing your documentation content, all features that are available via -Personalization are also available via Authentication. +Personalization are also available via Authentication. -Check out our docs for more info on [choosing Authentication vs Personalization]((./authentication-vs-personalization)). +Check out our docs for more info on [choosing Authentication vs Personalization](./authentication-vs-personalization).