Skip to content

Commit 3a1de94

Browse files
Add GitHub and GitLab setup details to Fern Editor page (#4257)
Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent faa6b03 commit 3a1de94

2 files changed

Lines changed: 31 additions & 8 deletions

File tree

.vale/styles/FernStyles/Headings.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,9 @@ exceptions:
3333
- SDKs
3434
- API Reference
3535
- API Explorer
36+
- Git
3637
- GitHub
38+
- GitLab
3739
- README
3840
- Action
3941
- Actions

fern/products/docs/pages/component-library/writing-content/visual-editor.mdx

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Fern Editor lets team members such as content writers, product managers, and mar
2323

2424
## Key features
2525

26-
<CardGroup cols={2}>
26+
<CardGroup cols={3}>
2727
<Card title="Component support" icon="duotone puzzle-piece">
2828
Create and edit Callouts, Cards, Accordions, Code Blocks, and other Fern components from the UI
2929
</Card>
@@ -35,19 +35,40 @@ Fern Editor lets team members such as content writers, product managers, and mar
3535
<Card title="Collaborative editing" icon="duotone users">
3636
Multiple team members can edit the same PR in the Editor without GitHub access
3737
</Card>
38-
39-
<Card title="Private Git providers" icon="duotone lock">
40-
Supports private GitHub and GitLab instances. [Contact support](mailto:support@buildwithfern.com) to set up.
41-
</Card>
4238
</CardGroup>
4339

4440
## Getting started
4541

46-
Log in to the [Dashboard](https://dashboard.buildwithfern.com/), connect your GitHub repository, and open Fern Editor from the top navigation.
42+
<Steps>
43+
44+
### Connect a Git provider
45+
46+
<Note title="Private instances">
47+
Private GitHub and GitLab instances are supported. [Contact support](mailto:support@buildwithfern.com) to set up.
48+
</Note>
49+
50+
<Tabs>
51+
<Tab title="GitHub">
52+
Install the [Fern GitHub app](https://github.com/apps/fern-api), then [connect your repository](/learn/dashboard/configuration/github-repo) in the [Dashboard](https://dashboard.buildwithfern.com/).
53+
</Tab>
54+
<Tab title="GitLab">
55+
GitLab requires manual setup:
56+
57+
1. [Create a personal access token](https://gitlab.com/-/user_settings/personal_access_tokens) in GitLab with the following scopes: `api`, `read_repository`, `write_repository`. Set the expiration date far into the future to avoid disrupting your Editor experience — you can revoke the token at any time.
58+
2. Contact Fern support via Slack or [email](mailto:support@buildwithfern.com) with your access token and GitLab repository URL.
59+
3. Once Fern configures the connection, [connect your repository](/learn/dashboard/configuration/github-repo) in the [Dashboard](https://dashboard.buildwithfern.com/).
60+
</Tab>
61+
</Tabs>
62+
63+
### Set up permissions
64+
65+
Configure [member permissions](/learn/dashboard/configuration/permissions) for your organization to control who can use Fern Editor. Admins and Editors can make changes; Viewers have read-only access.
66+
67+
### Open the Editor
4768

48-
From the Editor you can drag and drop media, create and delete pages, update branding (logo, favicon, title), and switch to dev mode for source code editing.
69+
Log in to the [Dashboard](https://dashboard.buildwithfern.com/) and open Fern Editor from the **Overview** tab. From here you can drag and drop media, create and delete pages, update branding (logo, favicon, title), and switch to dev mode for source code editing.
4970

50-
To manage access, see [Member permissions](/learn/dashboard/configuration/permissions). Admins and Editors can use the Editor; Viewers have read-only access.
71+
</Steps>
5172

5273
<Note title="Browser and device support">
5374
Fern Editor supports modern Chromium browsers on desktop. Mobile editing and support for other browsers are coming soon.

0 commit comments

Comments
 (0)