Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api-playground/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

<AccordionGroup>
<Accordion title="All of my OpenAPI pages are completely blank">
In this scenario, it's likely that either Mintlify cannot find your OpenAPI document,

Check warning on line 10 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L10

Use 'can't' instead of 'cannot'.
or your OpenAPI document is invalid.

Running `mint dev` locally should reveal some of these issues.
Expand All @@ -27,7 +27,7 @@
you could encounter this issue. You can convert your document at [editor.swagger.io](https://editor.swagger.io/) (under Edit \> Convert to OpenAPI 3):

<Frame>
![](/images/convert-oas-3.png)
![Screenshot of the Swagger Editor with the Edit menu expanded and the "Convert to OpenAPI 3" menu item highlighted.](/images/convert-oas-3.png)
</Frame>
</Accordion>
<Accordion title="One of my OpenAPI pages is completely blank">
Expand Down Expand Up @@ -64,8 +64,8 @@
<Accordion title="Requests from the API Playground don't work">
If you have a custom domain configured, this could be an issue with your reverse proxy. By
default, requests made via the API Playground start with a `POST` request to the
`/_mintlify/api/request` path on the docs site. If your reverse proxy is configured to only allow `GET`

Check warning on line 67 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L67

In general, use active voice instead of passive voice ('is configured').
requests, then all of these requests will fail. To fix this, configure your reverse proxy to

Check warning on line 68 in api-playground/troubleshooting.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/troubleshooting.mdx#L68

Avoid using 'will'.
allow `POST` requests to the `/_mintlify/api/request` path.

Alternatively, if your reverse proxy prevents you from accepting `POST` requests, you can configure Mintlify to send requests directly to your backend with the `api.playground.proxy` setting in the `docs.json`, as described in the [settings documentation](/organize/settings#param-proxy). When using this configuration, you will need to configure CORS on your server since requests will come directly from users' browsers rather than through your proxy.
Expand Down
2 changes: 1 addition & 1 deletion components/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@
<img
className="block"
src="https://mintlify-assets.b-cdn.net/hero-light.png"
alt=""
alt="Screenshot of the PearsDB Introduction page as an example of an image in an Update component."
/>
</Frame>

### Features
- Responsive design
- Anchor for each update
- Generated RSS feed entry for each update

Check warning on line 24 in components/update.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

components/update.mdx#L24

Spell out 'RSS', if it's unfamiliar to the audience.
</Update>

## How to use
Expand Down
6 changes: 3 additions & 3 deletions dashboard/sso.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: "Single sign-on (SSO)"

Check warning on line 2 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L2

Use 'single sign-on' instead of 'sign-on'.

Check warning on line 2 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L2

Use parentheses judiciously.

Check warning on line 2 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L2

Spell out 'SSO', if it's unfamiliar to the audience.
description: "Customize how your team can login to your admin dashboard"

Check warning on line 3 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L3

Use 'administrator' instead of 'admin'.
---

<Info>
SSO functionality is available on [Enterprise plan](https://mintlify.com/pricing?ref=sso).

Check warning on line 7 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L7

Use 'capability' or 'feature' instead of 'functionality'.
</Info>

Use single sign-on to your dashboard via SAML and OIDC. If you use Okta, Google Workspace, or Microsoft Entra, we have provider-specific documentation for setting up SSO. If you use another provider, please [contact us](mailto:support@mintlify.com).

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Use 'single sign-on' instead of 'sign-on'.

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Spell out 'SAML', if it's unfamiliar to the audience.

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Spell out 'OIDC', if it's unfamiliar to the audience.

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Try to avoid using first-person plural like 'we'.

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Use 'we've' instead of 'we have'.

Check warning on line 10 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L10

Spell out 'SSO', if it's unfamiliar to the audience.

## Okta

<Tabs>
<Tab title="SAML">

Check warning on line 15 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L15

Spell out 'SAML', if it's unfamiliar to the audience.
<Steps>
<Step title="Create an application">

Check warning on line 17 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L17

Use 'app' instead of 'application'.
Under `Applications`, click to create a new app integration using SAML 2.0.
</Step>
<Step title="Configure integration">
Enter the following:
* Single sign-on URL (provided by Mintlify)

Check warning on line 22 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L22

Use 'single sign-on' instead of 'sign-on'.
* Audience URI (provided by Mintlify)
* Name ID Format: `EmailAddress`
* Attribute Statements:
Expand All @@ -28,13 +28,13 @@
| `firstName` | Basic | `user.firstName` |
| `lastName` | Basic | `user.lastName` |
</Step>
<Step title="Send us your IdP information">

Check warning on line 31 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L31

Try to avoid using first-person plural like 'us'.
Once the application is set up, navigate to the sign-on tab and send us the metadata URL.

Check warning on line 32 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L32

Use 'app' instead of 'application'.

Check warning on line 32 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L32

In general, use active voice instead of passive voice ('is set').
We'll enable the connection from our side using this information.

Check warning on line 33 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L33

Try to avoid using first-person plural like 'We'.

Check warning on line 33 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L33

Try to avoid using first-person plural like 'our'.
</Step>
</Steps>
</Tab>
<Tab title="OIDC">

Check warning on line 37 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L37

Spell out 'OIDC', if it's unfamiliar to the audience.
<Steps>
<Step title="Create an application">
Under `Applications`, click to create a new app integration using OIDC.
Expand All @@ -44,14 +44,14 @@
Select the authorization code grant type and enter the Redirect URI provided by Mintlify.
</Step>
<Step title="Send us your IdP information">
Once the application is set up, navigate to the General tab and locate the client ID & client secret.

Check warning on line 47 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L47

In general, use active voice instead of passive voice ('is set').
Please securely provide us with these, along with your Okta instance URL (for example, `<your-tenant-name>.okta.com`). You can send these via a service like 1Password or SendSafely.

Check warning on line 48 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L48

Use parentheses judiciously.
</Step>
</Steps>
</Tab>
</Tabs>

## Google Workspace

Check warning on line 54 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L54

'Google Workspace' should use sentence-style capitalization.

<Tabs>
<Tab title="SAML">
Expand All @@ -59,24 +59,24 @@
<Step title="Create an application">
Under `Web and mobile apps`, select `Add custom SAML app` from the `Add app` dropdown.
<Frame>
![](/images/gsuite-add-custom-saml-app.png)
![Screenshot of the Google Workspace SAML application creation page with the "Add custom SAML app" menu item highlighted](/images/gsuite-add-custom-saml-app.png)

Check warning on line 62 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L62

Spell out 'SAML', if it's unfamiliar to the audience.

Check warning on line 62 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L62

Use 'app' instead of 'application'.
</Frame>
</Step>
<Step title="Send us your IdP information">
Copy the provided SSO URL, Entity ID, and x509 certificate and send it to the Mintlify team.

Check warning on line 66 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L66

Spell out 'SSO', if it's unfamiliar to the audience.
<Frame>
![](/images/gsuite-saml-metadata.png)
![Screenshot of the Google Workspace SAML application page with the SSO URL, Entity ID, and x509 certificate highlighted. The specific values for each of these are blurred out.](/images/gsuite-saml-metadata.png)

Check warning on line 68 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L68

Spell out 'SAML', if it's unfamiliar to the audience.

Check warning on line 68 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L68

Use 'app' instead of 'application'.

Check warning on line 68 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L68

Spell out 'SSO', if it's unfamiliar to the audience.

Check warning on line 68 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L68

In general, use active voice instead of passive voice ('are blurred').
</Frame>
</Step>
<Step title="Configure integration">
On the Service provider details page, enter the following:
* ACS URL (provided by Mintlify)

Check warning on line 73 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L73

Spell out 'ACS', if it's unfamiliar to the audience.
* Entity ID (provided by Mintlify)
* Name ID format: `EMAIL`
* Name ID: `Basic Information > Primary email`

<Frame>
![](/images/gsuite-sp-details.png)
![Screenshot of the Service provider details page with the ACS URL and Entity ID input fields highlighted.](/images/gsuite-sp-details.png)
</Frame>

On the next page, enter the following attribute statements:
Expand All @@ -94,16 +94,16 @@
## Microsoft Entra

<Tabs>
<Tab title="SAML">

Check warning on line 97 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L97

Spell out 'SAML', if it's unfamiliar to the audience.
<Steps>
<Step title="Create an application">

Check warning on line 99 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L99

Use 'app' instead of 'application'.
1. Under "Enterprise applications," select **New application**.

Check warning on line 100 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L100

Use 'app' instead of 'application'.
2. Select **Create your own application** and choose "Integrate any other application you don't find in the gallery (Non-gallery)."

Check warning on line 101 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L101

Use parentheses judiciously.
</Step>
<Step title="Configure SAML">

Check warning on line 103 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L103

Spell out 'SAML', if it's unfamiliar to the audience.
Navigate to the Single Sign-On setup page and select **SAML**. Under "Basic SAML Configuration," enter the following:
* Identifier (Entity ID): The Audience URI provided by Mintlify.

Check warning on line 105 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L105

Use parentheses judiciously.

Check warning on line 105 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L105

': T' should be in lowercase.
* Reply URL (Assertion Consumer Service URL): The ACS URL provided by Mintlify.

Check warning on line 106 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L106

Use parentheses judiciously.

Check warning on line 106 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L106

': T' should be in lowercase.

Check warning on line 106 in dashboard/sso.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/sso.mdx#L106

Spell out 'ACS', if it's unfamiliar to the audience.

Leave the other values blank and select **Save**.
</Step>
Expand Down
6 changes: 3 additions & 3 deletions deploy/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
description: "Sync your docs with a GitLab repo"
---

We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify.

Check warning on line 6 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L6

Try to avoid using first-person plural like 'We'.

- Mintlify uses access tokens to pull information from GitLab.
- GitLab uses webhooks to notify Mintlify when changes are made, enabling preview deployments for merge requests.

Check warning on line 9 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L9

In general, use active voice instead of passive voice ('are made').

## Set up the connection

<Note>
**HTTPS cloning required**: Your GitLab project must have HTTPS cloning enabled for Mintlify to access your repository. You can verify this in GitLab by going to your project's **Settings** > **General** > **Visibility and access controls** section.

Check warning on line 14 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L14

': Y' should be in lowercase.
</Note>

<Steps>
Expand Down Expand Up @@ -53,13 +53,13 @@

## Create the webhook

Webhooks allow us to receive events when changes are made so that we can

Check warning on line 56 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L56

Try to avoid using first-person plural like 'us'.

Check warning on line 56 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L56

In general, use active voice instead of passive voice ('are made').

Check warning on line 56 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L56

Try to avoid using first-person plural like 'we'.
automatically trigger deployments.

<Steps>
<Step title="Navigate to Settings > Webhooks and click 'Add new Webhook'">
<Frame>
<img src="/images/gitlab/gitlab-webhook.png" />
<img src="/images/gitlab/gitlab-webhook.png" alt="Screenshot of the Webhooks page in the GitLab dashboard." />
</Frame>
</Step>
<Step title="Set up URL and webhook">
Expand All @@ -69,12 +69,12 @@
<Step title="Paste token">
Paste the Webhook token generated after setting up the connection.
<Frame>
<img src="/images/gitlab/gitlab-show-webtoken.png" />
<img src="/images/gitlab/gitlab-show-webtoken.png" alt="Screenshot of the GitLab connection in the Mintlify dashboard. The Show Webtoken button is highlighted." />
</Frame>
</Step>
<Step title="Select events">
Select these events to trigger the webhook:
- **Push events** (All branches)

Check warning on line 77 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L77

Use parentheses judiciously.
- **Merge requests events**

When you're done it should look like this:
Expand All @@ -83,11 +83,11 @@
</Frame>
</Step>
<Step title="Test the Webhook">
After creating the Webhook, click the "Test" dropdown and select "Push events" to send a sample payload to ensure it's configured correctly. It'll say "Hook executed successfully: HTTP 200" if configured correctly.

Check warning on line 86 in deploy/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/gitlab.mdx#L86

': H' should be in lowercase.

This will help you verify that everything is working correctly and that your documentation will sync properly with your GitLab repository.
<Frame>
<img src="/images/gitlab/gitlab-project-webtoken-test.png" />
<img src="/images/gitlab/gitlab-project-webtoken-test.png" alt="Screenshot of the GitLab Webhooks page. The 'Push events' menu item is highlighted in the 'Test' menu." />
</Frame>

</Step>
Expand Down
Loading