Skip to content

Commit cebf026

Browse files
authored
add info about changing source (#773)
1 parent c05f603 commit cebf026

File tree

1 file changed

+21
-29
lines changed

1 file changed

+21
-29
lines changed

settings/github.mdx

Lines changed: 21 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,53 +6,45 @@ icon: "github"
66

77
Mintlify uses a GitHub App to automatically sync your documentation with your GitHub repository.
88

9-
## Installation
9+
## Installing the GitHub App
1010

11-
Install the Mintlify GitHub App on the GitHub account or organization that owns your docs repository. Installing a GitHub App requires either
12-
organization ownership or admin permissions in a repository. If you lack the necessary permissions, the repository owner will need to approve the request.
11+
Install the Mintlify GitHub App on the GitHub account or organization that owns your docs repository. You must have organization ownership or admin permissions in a repository to install the app. If you lack the necessary permissions, the repository owner must approve the installation request.
1312

14-
You can install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).
13+
Install the Mintlify GitHub App through your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).
1514

15+
<Tip>
1616
We recommend granting access only to the repository where your docs are hosted.
17+
</Tip>
1718

1819
<Frame>
19-
<img className="h-80" src="/images/github/select-repos.png" />
20+
<img className="h-80" alt="Mintlify GitHub App installation page with the 'Only select repositories' option selected." src="/images/github/select-repos.png" />
2021
</Frame>
2122

2223
## Permissions
2324

2425
When you install the GitHub app, you will be prompted to grant the following permissions:
2526

26-
- **Read** access to `metadata`
27-
- **Read** and **write** access to `checks`, `code`, `deployments`, `pull requests`,
28-
and `workflows`
27+
Read permissions:
28+
* `metadata`: Basic repository information
2929

30-
These permissions are leveraged to provide a seamless experience when managing
31-
your docs.
32-
33-
When you make a commit to the branch you configured as your docs deployment
34-
branch, we fetch the contents of the files changed to update your docs. To
35-
accomplish this we need read access to your `contents`.
36-
37-
When pull requests are created we create a check and preview deployment which is
38-
why we need write access to `checks` and `deployments`.
39-
40-
Inside the Mintlify web editor, Mintlify works on your behalf to create branches
41-
and pull requests which is why we need write access to `pull requests` and
42-
`workflows`.
30+
Read and write permissions:
31+
* `checks`: Create status checks on pull requests
32+
* `code`: Read file changes when you commit to your docs branch
33+
* `deployments`: Generate preview deployments for pull requests
34+
* `pull requests`: Create branches and pull requests from the web editor
35+
* `workflows`: Manage GitHub Actions for docs deployments
4336

4437
<Info>
45-
If you are concerned about the write permissions, the GitHub App will only
46-
have access to the repos you give it access to _and_ if you have branch
47-
protections on it _cannot_ push directly to your branches - it abides by your
48-
branch protection rules.
38+
The app only accesses repositories that you explicitly grant it access to. If you have branch protection rules enabled, the app cannot push directly to protected branches.
4939
</Info>
5040

51-
## Repositories Installations
41+
## Managing repository access
42+
43+
When installing our GitHub App, you can grant access to all of your repositories or specific ones. We recommend only granting access to the repositories where your documentation is located. You can modify this selection anytime in your [GitHub app settings](https://github.com/apps/mintlify/installations/new).
44+
45+
## Configuring docs source
5246

53-
When installing our GitHub app, you will be prompted to select all repositories
54-
or a subset of them. This selection can be changed at any time by going to the
55-
[GitHub app settings](https://github.com/apps/mintlify/installations/new).
47+
Change the organization, repository, or branch that your documentation is built from in the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) section of your dashboard.
5648

5749
## Troubleshooting
5850

0 commit comments

Comments
 (0)