From ef325b3d0f54f1beb1f29a49e8776ca6fd6fd896 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 11 Sep 2025 23:59:16 +0000 Subject: [PATCH 1/2] Update settings/gitlab.mdx --- settings/gitlab.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/settings/gitlab.mdx b/settings/gitlab.mdx index 01c0b82bf..32e42aed2 100644 --- a/settings/gitlab.mdx +++ b/settings/gitlab.mdx @@ -30,6 +30,10 @@ changes between GitLab and Mintlify. c. Finally click `Create project access token` and copy the token. + + If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire after 1 year. + + From d22ee3bb1faba2e401607eb528cb923c677df3d7 Mon Sep 17 00:00:00 2001 From: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> Date: Fri, 12 Sep 2025 09:55:27 -0700 Subject: [PATCH 2/2] copy edit and add note on tokens --- settings/gitlab.mdx | 54 ++++++++++++++++++++------------------------- 1 file changed, 24 insertions(+), 30 deletions(-) diff --git a/settings/gitlab.mdx b/settings/gitlab.mdx index 32e42aed2..689c22e7c 100644 --- a/settings/gitlab.mdx +++ b/settings/gitlab.mdx @@ -4,45 +4,46 @@ description: "Sync your docs with a GitLab repo" icon: "gitlab" --- -We use a combination of Access tokens and Webhooks to authenticate and sync -changes between GitLab and Mintlify. +We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. -- We use Access tokens to pull information from GitLab. -- We use Webhooks so GitLab can notify Mintlify when changes are made. - - This allows Mintlify to create preview deployments when a MR is created. +- 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. ## Set up the connection - Within your GitLab project, navigate to `Settings` > `General` and find the `Project ID`. + In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**. - + The General Settings page in the GitLab dashboard. The Project ID is highlighted. - a. Navigate to `Settings` > `Access Tokens`. - - b. Select `Add new token`. - 1. Name the token "Mintlify". - 2. If you have a private repo, you must set the role as `Maintainer`. - 3. Choose `api` and `read_api` for the scopes. - - c. Finally click `Create project access token` and copy the token. + Navigate to **Settings** > **Access Tokens** and select **Add new token**. + + Configure the token with these settings: + - **Name**: Mintlify + - **Role**: Maintainer (required for private repos) + - **Scopes**: `api` and `read_api` + + Click **Create project access token** and copy the token. - If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire after 1 year. + 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. - + The Access tokens page in the GitLab dashboard. The settings to configure for Mintlify are highlighted. - 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. + In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings): + 1. Enter your project ID and access token. + 2. Complete any other required configurations. + 3. Click **Save Changes**. - + The Git Settings page in the Mintlify dashboard. The GitLab configuration settings are highlighted. @@ -69,13 +70,13 @@ automatically trigger deployments. - Select the events you want to trigger the webhook: - - Push events (All branches) - - Merge requests events + Select these events to trigger the webhook: + - **Push events** (All branches) + - **Merge requests events** When you're done it should look like this: - + The Webhook page in the GitLab dashboard. The settings to configure for Mintlify are highlighted. @@ -88,10 +89,3 @@ automatically trigger deployments. - - - Reach out to the Mintlify team if you need help. Contact us - [here](https://mintlify.com/enterprise). - - -[git-settings]: https://dashboard.mintlify.com/settings/deployment/git-settings