Skip to content
Merged
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/static-export/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
| API playground ("Try it") | <Icon icon="check" color="#16a34a" /> | <Icon icon="check" color="#16a34a" /> | Configurable |
| Static export bundle | <Icon icon="check" color="#16a34a" /> | <Icon icon="check" color="#16a34a" /> | <Icon icon="check" color="#16a34a" /> |

## Endpoints

Check warning on line 41 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L41

Use 'endpoints?' instead of 'Endpoints'.

- [Start static export job](/api/static-export/start-job): Start a static export job for a deployment.
- [Get static export job status](/api/static-export/get-job-status): Poll the status and progress of a running job.
Expand All @@ -46,11 +46,11 @@

## Authentication

Authenticate requests with your admin API key. Generate an admin API key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secrets--do not expose them in client-side code.
Authenticate requests with your admin API key. Generate an admin API key on the [API keys page](https://app.mintlify.com/settings/organization/api-keys) in your dashboard. Admin API keys begin with the `mint_` prefix and are server-side secretsdo not expose them in client-side code.

## Deploy the bundle to your Enterprise Helm chart

Check warning on line 51 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L51

'Deploy the bundle to your Enterprise Helm chart' should use sentence-style capitalization.

Self-hosted Mintlify is deployed with the Helm chart in the [`mintlify/enterprise`](https://github.com/mintlify/enterprise) repository. Once a static export job produces a bundle, you point the chart at the bundle and the deployment serves it from your own infrastructure.

Check warning on line 53 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L53

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

<Steps>
<Step title="Add the bundle reference to your values">
Expand Down Expand Up @@ -133,4 +133,4 @@
--set staticExport.bundleUrl="${{ steps.bundle.outputs.bundle_url }}"
```

Store your admin API key as the `MINTLIFY_ADMIN_KEY` repository secret, and configure cluster credentials (for example, with `azure/setup-helm` and your kubeconfig) before the deploy step.

Check warning on line 136 in api/static-export/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/static-export/overview.mdx#L136

Did you really mean 'kubeconfig'?
Loading