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 deploy/csp-configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: "Content Security Policy (CSP) configuration"

Check warning on line 2 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L2

Use parentheses judiciously.
sidebarTitle: "CSP configuration"
description: "Configure CSP headers to allow Mintlify resources while maintaining security for reverse proxies, firewalls, and networks that enforce strict security policies."

Check warning on line 4 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L4

Use 'firewall rules' instead of 'firewalls'.
keywords: ["Content Security Policy", "CSP directives", "security headers", "XSS prevention"]

Check warning on line 5 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L5

'CSP directives' should use sentence-style capitalization.
---

Content Security Policy (CSP) is a security standard that helps prevent cross-site scripting (XSS) attacks by controlling which resources a web page can load. Mintlify serves a default CSP that protects most sites. If you host your documentation behind a reverse proxy or firewall, that overwrites the default CSP, you may need to configure CSP headers for features to function properly.

Check warning on line 8 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L8

Use parentheses judiciously.

## CSP directives

The following CSP directives are used to control which resources can be loaded:

Check warning on line 12 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L12

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

Check warning on line 12 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L12

In general, use active voice instead of passive voice ('be loaded').

- `script-src`: Controls which scripts can be executed

Check warning on line 14 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L14

In general, use active voice instead of passive voice ('be executed').
- `style-src`: Controls which stylesheets can be loaded

Check warning on line 15 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L15

In general, use active voice instead of passive voice ('be loaded').
- `font-src`: Controls which fonts can be loaded

Check warning on line 16 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L16

In general, use active voice instead of passive voice ('be loaded').
- `img-src`: Controls which images, icons, and logos can be loaded

Check warning on line 17 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L17

In general, use active voice instead of passive voice ('be loaded').
- `connect-src`: Controls which URLs can be connected to for API calls and WebSocket connections

Check warning on line 18 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L18

In general, use active voice instead of passive voice ('be connected').

Check warning on line 18 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L18

Use 'websockets?' instead of 'WebSocket'.
- `frame-src`: Controls which URLs can be embedded in frames or iframes

Check warning on line 19 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L19

In general, use active voice instead of passive voice ('be embedded').
- `default-src`: Fallback for other directives when not explicitly set

## Domain whitelist
## Domain allowlist

| Domain | Purpose | CSP directive | Required |
|:-------|:--------|:--------------|:-------|
Expand All @@ -35,7 +35,7 @@
| `cdn.jsdelivr.net` | Emoji assets for OG images | `script-src`, `img-src` | Required |
| `mintlify.s3.us-west-1.amazonaws.com` | S3-hosted images | `img-src` | Required |
| `fonts.googleapis.com` | Google Fonts | `style-src`, `font-src` | Optional |
| `www.googletagmanager.com` | Google Analytics/GTM | `script-src`, `connect-src` | Optional |

Check warning on line 38 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L38

Spell out 'GTM', if it's unfamiliar to the audience.
| `cdn.segment.com` | Segment analytics | `script-src`, `connect-src` | Optional |
| `plausible.io` | Plausible analytics | `script-src`, `connect-src` | Optional |
| `us.posthog.com` | PostHog analytics | `connect-src` | Optional |
Expand All @@ -46,7 +46,7 @@
| `browser.sentry-cdn.com` | Sentry error tracking | `script-src`, `connect-src` | Optional |
| `js.sentry-cdn.com` | Sentry JavaScript SDK | `script-src` | Optional |

## Example CSP configuration

Check warning on line 49 in deploy/csp-configuration.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/csp-configuration.mdx#L49

'Example CSP configuration' should use sentence-style capitalization.

<Note>
Only include domains for services that you use. Remove any analytics domains that you have not configured for your documentation.
Expand Down
2 changes: 1 addition & 1 deletion deploy/ghes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
keywords: ["GitHub Enterprise Server", "GHES", "GitHub Enterprise"]
---

This guide walks you through setting up the Mintlify GitHub App on your GitHub Enterprise Server (GHES) installation. To connect a GHES instance to Mintlify, you must create a local version of our app within your self-hosted environment that communicates with our remote server.

Check warning on line 7 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L7

Use parentheses judiciously.

If you use a cloud-hosted GitHub instance, see the [GitHub](/deploy/github) page for setup instructions.

Expand All @@ -12,21 +12,21 @@

- Admin privileges on your GitHub Enterprise Server organization where you want to install the app
- Access to your organization's repositories where you want to install the app
- Network connectivity to communicate with our external services (see [Network requirements](#network-requirements) section below)

Check warning on line 15 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L15

Use parentheses judiciously.

### Network requirements

#### Outbound connectivity

Your GitHub Enterprise Server must be able to reach:
- Mintlify's API endpoints (https://leaves.mintlify.com)

Check warning on line 22 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L22

Use parentheses judiciously.
- Webhook receivers (port 443)

Check warning on line 23 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L23

Use parentheses judiciously.

#### Firewall configuration

The following outbound connections must be allowed:

Check warning on line 27 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L27

In general, use active voice instead of passive voice ('be allowed').
- Connections from Mintlify's static IP: `54.242.90.151`
- HTTPS (port 443) to Mintlify's service domains

Check warning on line 29 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L29

Use parentheses judiciously.
- DNS resolution for Mintlify's service domains

## Step 1: Register the GitHub App
Expand All @@ -52,7 +52,7 @@
- **GitHub App name:** `Mintlify`
- **Description:** `Integration with Mintlify services`
- **Homepage URL:** `https://mintlify.com`
- **User authorization callback URL:** `https://your-github-server.com/` (replace with your actual GHES domain)

Check warning on line 55 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L55

Use parentheses judiciously.

</Step>
</Steps>
Expand All @@ -61,7 +61,7 @@

<Steps>
<Step title="Set repository permissions">
Set the following permissions for the app. No Organization, Account, or Enterprise permissions are required:

Check warning on line 64 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L64

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

- **Checks:** Read and write
- **Contents:** Read and write
Expand Down Expand Up @@ -90,7 +90,7 @@
<Step title="Create the app">
Click **Create GitHub App**.

You'll be redirected to the app's settings page.

Check warning on line 93 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L93

In general, use active voice instead of passive voice ('be redirected').
</Step>

<Step title="Generate private key">
Expand All @@ -102,9 +102,9 @@
<Step title="Note app credentials">
Record the following:

- **App ID** (visible at the top of the settings page)

Check warning on line 105 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L105

Use parentheses judiciously.
- **Client ID** (in the "About" section)

Check warning on line 106 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L106

Use parentheses judiciously.
- **Client Secret** (generate and record it securely)

Check warning on line 107 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L107

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

Expand All @@ -119,11 +119,11 @@
<Step title="Choose installation scope">
Select either:

- **All repositories** (for organization-wide access)

Check warning on line 122 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L122

Use parentheses judiciously.
- **Only select repositories** (choose specific repositories)

Check warning on line 123 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L123

Use parentheses judiciously.

<Tip>
We recommend selecting "Only select repositories" and limiting the app to only the repositories where your documentation is located.

Check warning on line 126 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L126

In general, use active voice instead of passive voice ('is located').
</Tip>
</Step>

Expand All @@ -144,8 +144,8 @@
<Step title="Set webhook URL">
Configure the following:

- **Webhook URL:** `https://leaves.mintlify.com/github-enterprise/:subdomain` (replace `:subdomain` with the URL that we provide you with)

Check warning on line 147 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L147

Use parentheses judiciously.

Check warning on line 147 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L147

Use 'webhook' instead of 'Webhook'.
- **Webhook secret:** Generate a random string (32+ characters) and record it securely. Mintlify can also generate this and provide it to you.

Check warning on line 148 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L148

Use 'webhook' instead of 'Webhook'.

Check warning on line 148 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L148

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

Expand All @@ -154,16 +154,16 @@

### Required credentials
- GitHub Enterprise Server base URL: https://your-github-server.com
- App ID: (from step 3)

Check warning on line 157 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L157

Use parentheses judiciously.
- App client ID: (from step 3)

Check warning on line 158 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L158

Use parentheses judiciously.
- App client secret: (from step 3)

Check warning on line 159 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L159

Use parentheses judiciously.
- Installation ID: (from step 4)

Check warning on line 160 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L160

Use parentheses judiciously.
- Private key: The entire contents of the `.pem` file (should be shared via secure file transfer)

Check warning on line 161 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L161

Use parentheses judiciously.

Check warning on line 161 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L161

In general, use active voice instead of passive voice ('be shared').
- Webhook secret: (from step 5)

Check warning on line 162 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L162

Use 'webhook' instead of 'Webhook'.

Check warning on line 162 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L162

Use parentheses judiciously.

### Optional credentials for troubleshooting
- Organization name: Your GitHub organization name
- Repository names: Specific repositories where the app is installed

Check warning on line 166 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L166

In general, use active voice instead of passive voice ('is installed').
- GitHub Enterprise Server version: Found in your site admin dashboard

## Mintlify connection
Expand All @@ -172,7 +172,7 @@
- Integrate your GHES environment with an existing Mintlify deployment.
- Integrate your GHES environment with a new Mintlify deployment that we provision for you.

After your GHES environment is integrated with a Mintlify deployment, you are ready to enable webhooks for your GitHub App.

Check warning on line 175 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L175

In general, use active voice instead of passive voice ('is integrated').

<Note>
The webhook URL may change based on our configuration. We test the integration and provide you with the new URL.
Expand All @@ -194,7 +194,7 @@
</Step>
</Steps>

## FAQ and Troubleshooting

Check warning on line 197 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L197

'FAQ and Troubleshooting' should use sentence-style capitalization.

<AccordionGroup>
<Accordion title="The app installation is failing with permission errors.">
Expand All @@ -208,7 +208,7 @@
<Accordion title="Webhooks aren't being delivered">
- Verify the webhook URL is correct and accessible.
- Ensure your firewall allows outbound HTTPS connections.
- Check the webhook secret matches what was configured.

Check warning on line 211 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L211

In general, use active voice instead of passive voice ('was configured').
- Review webhook delivery logs in the "Advanced" tab of your GitHub App settings.
</Accordion>

Expand All @@ -219,8 +219,8 @@
</Accordion>

<Accordion title="The app installs, but doesn't respond to events.">
- Ensure webhooks are being delivered and acknowledged by our server with response code 200.

Check warning on line 222 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L222

In general, use active voice instead of passive voice ('being delivered').
- Required permissions were granted during installation.

Check warning on line 223 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L223

In general, use active voice instead of passive voice ('were granted').
</Accordion>

<Accordion title="Can I limit which repositories the app accesses?">
Expand All @@ -230,15 +230,15 @@
<Accordion title="How do I update app permissions later?">
- Go to the app settings as a site admin.
- Modify permissions as needed.
- The app will need to be re-approved by organization owners.

Check warning on line 233 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L233

Avoid using 'will'.
- Notify us of any permission changes as they may affect functionality.

Check warning on line 234 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L234

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

<Accordion title="Our GHES is behind a corporate firewall, nginx proxy, or similar setup.">
You must:

- Whitelist our service domains in your firewall.
- Add our service domains to your firewall allowlist.
- Ensure outbound HTTPS (port 443) connectivity.

Check warning on line 241 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L241

Use parentheses judiciously.
- If direct internet access is not allowed, set up a proxy.
</Accordion>

Expand All @@ -252,7 +252,7 @@
- Your GitHub Enterprise Server version.
- Specific error messages.
- Screenshots of any issues.
- Network/firewall configuration details (if relevant).

Check warning on line 255 in deploy/ghes.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/ghes.mdx#L255

Use parentheses judiciously.
</Accordion>
</AccordionGroup>

2 changes: 1 addition & 1 deletion installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

## Prerequisites

- [Node.js](https://nodejs.org/en) v20.17.0+ (LTS versions recommended) installed

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Use parentheses judiciously.

Check warning on line 24 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L24

Spell out 'LTS', if it's unfamiliar to the audience.
- [Git](https://git-scm.com/downloads) installed
- Your documentation repository cloned locally

Expand Down Expand Up @@ -181,7 +181,7 @@
mint broken-links
```

The command ignores files matching [.mintignore](/organize/mintignore) patterns. Links that point to ignored files are reported as broken.

Check warning on line 184 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L184

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

To also check anchor links like `/path/to/page#anchor`, use the `--check-anchors` flag:

Expand Down Expand Up @@ -217,7 +217,7 @@

Use flags to configure the validation command.

- `--groups [groupname]`: Mock user groups for validation (useful when testing group-based access control)

Check warning on line 220 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L220

Use parentheses judiciously.
- `--disable-openapi`: Disable OpenAPI file generation during validation

### Check OpenAPI spec
Expand All @@ -228,7 +228,7 @@
mint openapi-check <OpenAPI filename or URL>
```

Pass a filename (for example, `./openapi.yaml`) or a URL (for example, `https://petstore3.swagger.io/api/v3/openapi.json`).

Check warning on line 231 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L231

Use parentheses judiciously.

### Rename files

Expand Down Expand Up @@ -300,8 +300,8 @@
```
</Accordion>
<Accordion title="Client version shows 'none' after installation">
If you run `mint version` and the client version displays as `none`, the CLI may be unable to download the client application due to a corporate firewall or VPN blocking the download.

Check warning on line 303 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L303

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

**Solution:** Ask your IT administrator to whitelist `releases.mintlify.com` to enable local development with the CLI.
**Solution:** Ask your IT administrator to add `releases.mintlify.com` to your network allowlist to enable local development with the CLI.
</Accordion>
</AccordionGroup>
2 changes: 1 addition & 1 deletion integrations/privacy/osano.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Replace `OSANO_SCRIPT_URL` with your Osano script URL. Your script URL is the `s
<Accordion
title="Pages not loading with Strict compliance mode"
>
If your documentation pages aren't loading properly when using Osano's **Strict** compliance mode, you'll need to whitelist Mintlify's domain to allow images and other assets to load.
If your documentation pages aren't loading properly when using Osano's **Strict** compliance mode, you'll need to add Mintlify's domain to your allowlist to allow images and other assets to load.

<Steps>
<Step title="Navigate to Managed Rules">
Expand Down