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
8 changes: 0 additions & 8 deletions deploy/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,6 @@

If you skipped connecting your own Git repository during onboarding, your documentation lives in a private repository owned by the Mintlify organization. To move it to your own account or organization:

1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
2. Click **Clone as Private** or **Clone as Public**. Public repos allow anyone to view your documentation source and submit issues or suggestions. Private repos restrict access to your team.
3. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below.

### Alternative: Download and create your own repository

If you want a private repository without granting elevated OAuth permissions, you can manually transfer your documentation:

1. Go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) in your dashboard.
2. Download your documentation as a zip file.
3. Create a new repository on GitHub or GitLab.
Expand All @@ -36,7 +28,7 @@
5. Return to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and connect your new repository to Mintlify.
6. Install the GitHub App by following the steps in [Install the GitHub App](#install-the-github-app) below.

## Install the GitHub App

Check warning on line 31 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L31

'Install the GitHub App' should use sentence-style capitalization.

<Note>
You must have organization ownership or administrator permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
Expand Down Expand Up @@ -83,7 +75,7 @@

Change the organization, repository, or branch that your documentation builds from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.

## GitHub Enterprise with IP allowlists

Check warning on line 78 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L78

Did you really mean 'allowlists'?

If your GitHub Enterprise Cloud organization has an IP allowlist enabled, you need to add Mintlify's egress IP address (`54.242.90.151`) to your allowlist for the GitHub App to function properly.

Expand All @@ -110,7 +102,7 @@
</Accordion>
</AccordionGroup>

### GitHub App connection issues

Check warning on line 105 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L105

'GitHub App connection issues' should use sentence-style capitalization.

If you encounter problems with the GitHub app, resetting the connection can solve most problems.

Expand All @@ -127,7 +119,7 @@

### Feedback add-ons are unavailable

The edit suggestions and raise issues feedback features are only available for public GitHub repositories. If these options are disabled in your dashboard, check your repository visibility.

Check warning on line 122 in deploy/github.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/github.mdx#L122

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

If your repository is public and you cannot enable the edit suggestions or raise issues options in your dashboard, revalidate your Git settings.

Expand Down