Skip to content

Commit 35e6f29

Browse files
Add documentation for connecting a GitHub repository in the dashboard (#3348)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent 2585706 commit 35e6f29

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

fern/products/dashboard/dashboard.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ navigation:
88
- page: Member permissions
99
path: ./pages/permissions.mdx
1010
slug: permissions
11+
- page: Connect a GitHub repository
12+
path: ./pages/github-repo.mdx
13+
slug: github-repo
1114
- page: Set up SSO
1215
path: ./pages/sso.mdx
1316
slug: sso
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Connect a GitHub repository
3+
description: Link your GitHub repository to your Fern project for automated deployments.
4+
---
5+
6+
Connect the Fern Dashboard to the GitHub repository containing your Fern documentation. Once connected, your docs automatically deploy when you push changes.
7+
8+
To complete the repo connection, you need:
9+
10+
- **Admin access** to the GitHub organization where the repository exists
11+
- The [Fern GitHub app](https://github.com/apps/fern-api) installed on the repository
12+
13+
## Setup
14+
15+
<Steps>
16+
<Step title="Open the Dashboard">
17+
18+
Navigate to the [Fern Dashboard](https://dashboard.buildwithfern.com/) and select your documentation site.
19+
</Step>
20+
21+
<Step title="Connect your repository">
22+
23+
In the **Source** section of the **Overview** tab, select **Connect repo** and follow the prompts to authorize the Fern API GitHub app.
24+
25+
</Step>
26+
27+
<Step title="Install the GitHub app">
28+
29+
If you haven't already installed the [Fern GitHub app](https://github.com/apps/fern-api), you'll be prompted to install it on your repository. You must be an admin on the GitHub organization to complete this step.
30+
31+
</Step>
32+
33+
<Step title="Select your repository">
34+
35+
Choose the repository containing your Fern documentation. Once connected, Fern automatically deploys your documentation when you push changes to the configured branch.
36+
</Step>
37+
</Steps>

fern/products/dashboard/pages/overview.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete
2727
<Card
2828
title="Integrate GitHub"
2929
icon="brands github"
30+
href="/learn/dashboard/configuration/github-repo"
3031
>
3132
Connect your GitHub repository to your project.
3233
</Card>

0 commit comments

Comments
 (0)