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
4 changes: 4 additions & 0 deletions settings/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@
icon: "gitlab"
---

We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify.

Check warning on line 7 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L7

Try to avoid using first-person plural like 'We'.

- Mintlify uses access tokens to pull information from GitLab.
- GitLab uses webhooks to notify Mintlify when changes are made, enabling preview deployments for merge requests.

Check warning on line 10 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L10

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

## Set up the connection

<Note>
**HTTPS cloning required**: Your GitLab project must have HTTPS cloning enabled for Mintlify to access your repository. You can verify this in GitLab by going to your project's **Settings** > **General** > **Visibility and access controls** section.

Check warning on line 15 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L15

': Y' should be in lowercase.
</Note>

<Steps>
<Step title="Find your project ID">
In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**.
Expand Down Expand Up @@ -50,7 +54,7 @@

## Create the webhook

Webhooks allow us to receive events when changes are made so that we can

Check warning on line 57 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L57

Try to avoid using first-person plural like 'us'.

Check warning on line 57 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L57

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

Check warning on line 57 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L57

Try to avoid using first-person plural like 'we'.
automatically trigger deployments.

<Steps>
Expand All @@ -71,7 +75,7 @@
</Step>
<Step title="Select events">
Select these events to trigger the webhook:
- **Push events** (All branches)

Check warning on line 78 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L78

Use parentheses judiciously.
- **Merge requests events**

When you're done it should look like this:
Expand All @@ -80,7 +84,7 @@
</Frame>
</Step>
<Step title="Test the Webhook">
After creating the Webhook, click the "Test" dropdown and select "Push events" to send a sample payload to ensure it's configured correctly. It'll say "Hook executed successfully: HTTP 200" if configured correctly.

Check warning on line 87 in settings/gitlab.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

settings/gitlab.mdx#L87

': H' should be in lowercase.

This will help you verify that everything is working correctly and that your documentation will sync properly with your GitLab repository.
<Frame>
Expand Down
Loading