Skip to content

Commit d22ee3b

Browse files
committed
copy edit and add note on tokens
1 parent ef325b3 commit d22ee3b

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

settings/gitlab.mdx

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,45 +4,46 @@ description: "Sync your docs with a GitLab repo"
44
icon: "gitlab"
55
---
66

7-
We use a combination of Access tokens and Webhooks to authenticate and sync
8-
changes between GitLab and Mintlify.
7+
We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify.
98

10-
- We use Access tokens to pull information from GitLab.
11-
- We use Webhooks so GitLab can notify Mintlify when changes are made.
12-
- This allows Mintlify to create preview deployments when a MR is created.
9+
- Mintlify uses access tokens to pull information from GitLab.
10+
- GitLab uses webhooks to notify Mintlify when changes are made, enabling preview deployments for merge requests.
1311

1412
## Set up the connection
1513

1614
<Steps>
1715
<Step title="Find your project ID">
18-
Within your GitLab project, navigate to `Settings` > `General` and find the `Project ID`.
16+
In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**.
1917
<Frame>
20-
<img src="/images/gitlab/gitlab-project-id.png" />
18+
<img src="/images/gitlab/gitlab-project-id.png" alt="The General Settings page in the GitLab dashboard. The Project ID is highlighted." />
2119
</Frame>
2220
</Step>
2321
<Step title="Generate an access token">
24-
a. Navigate to `Settings` > `Access Tokens`.
25-
26-
b. Select `Add new token`.
27-
1. Name the token "Mintlify".
28-
2. If you have a private repo, you must set the role as `Maintainer`.
29-
3. Choose `api` and `read_api` for the scopes.
30-
31-
c. Finally click `Create project access token` and copy the token.
22+
Navigate to **Settings** > **Access Tokens** and select **Add new token**.
23+
24+
Configure the token with these settings:
25+
- **Name**: Mintlify
26+
- **Role**: Maintainer (required for private repos)
27+
- **Scopes**: `api` and `read_api`
28+
29+
Click **Create project access token** and copy the token.
3230

3331
<Note>
34-
If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire after 1 year.
32+
If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire and must be updated.
3533
</Note>
3634

3735
<Frame>
38-
<img src="/images/gitlab/gitlab-project-access-token.png" />
36+
<img src="/images/gitlab/gitlab-project-access-token.png" alt="The Access tokens page in the GitLab dashboard. The settings to configure for Mintlify are highlighted." />
3937
</Frame>
4038

4139
</Step>
4240
<Step title="Set up the connection">
43-
Within the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings), add the project ID and access token from the previous steps alongside the other configurations. Click "Save Changes" when you're done.
41+
In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings):
42+
1. Enter your project ID and access token.
43+
2. Complete any other required configurations.
44+
3. Click **Save Changes**.
4445
<Frame>
45-
<img src="/images/gitlab/gitlab-config.png" />
46+
<img src="/images/gitlab/gitlab-config.png" alt="The Git Settings page in the Mintlify dashboard. The GitLab configuration settings are highlighted." />
4647
</Frame>
4748
</Step>
4849
</Steps>
@@ -69,13 +70,13 @@ automatically trigger deployments.
6970
</Frame>
7071
</Step>
7172
<Step title="Select events">
72-
Select the events you want to trigger the webhook:
73-
- Push events (All branches)
74-
- Merge requests events
73+
Select these events to trigger the webhook:
74+
- **Push events** (All branches)
75+
- **Merge requests events**
7576

7677
When you're done it should look like this:
7778
<Frame>
78-
<img src="/images/gitlab/gitlab-project-webtoken.png" />
79+
<img src="/images/gitlab/gitlab-project-webtoken.png" alt="The Webhook page in the GitLab dashboard. The settings to configure for Mintlify are highlighted." />
7980
</Frame>
8081
</Step>
8182
<Step title="Test the Webhook">
@@ -88,10 +89,3 @@ automatically trigger deployments.
8889

8990
</Step>
9091
</Steps>
91-
92-
<Note>
93-
Reach out to the Mintlify team if you need help. Contact us
94-
[here](https://mintlify.com/enterprise).
95-
</Note>
96-
97-
[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings

0 commit comments

Comments
 (0)