From dbf8b1ccd30bbbb1bd71a5232f96206653a42076 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 16 Apr 2026 19:18:41 +0000 Subject: [PATCH] Update GitLab docs to reflect the new setup wizard flow Generated-By: mintlify-agent --- deploy/gitlab.mdx | 38 ++++++++++++++++++++++++++++---------- 1 file changed, 28 insertions(+), 10 deletions(-) diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index c73daad5d..9677ccacc 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -11,7 +11,21 @@ Mintlify uses access tokens and webhooks to authenticate and sync changes betwee ## Set up the connection +When you open [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) for the first time, a setup wizard guides you through connecting your GitLab repository. + + + In the [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) page, select **Connect to GitLab** and click **Continue**. + + + If your documentation is hosted by Mintlify, download it as a zip file. Create a new repository in GitLab, extract the zip contents, and push them to your repository. + + Click **Continue setup** to proceed. + + + If you already have a GitLab repository with your documentation, you can skip the download and click **Continue setup** directly. + + In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**. @@ -20,12 +34,12 @@ Mintlify uses access tokens and webhooks to authenticate and sync changes betwee 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. @@ -35,15 +49,15 @@ Mintlify uses access tokens and webhooks to authenticate and sync changes betwee The Access tokens page in the GitLab dashboard. The settings to configure for Mintlify are highlighted. - - - In the [Mintlify dashboard](https://dashboard.mintlify.com/settings/deployment/git-settings): - 1. Enter your project ID and access token. - 2. If you have a monorepo and your documentation is not at the root of your repository, enable the **Set up as monorepo** toggle and enter the relative path to your docs directory. - 3. If you use a self-hosted GitLab instance, enable the **Set up as self-hosted** toggle and enter your GitLab instance's host URL (for example, `https://gitlab.your-domain.com`). Your instance must be publicly accessible for Mintlify to reach it. - 4. Select the branch to deploy your documentation from. - 5. Click **Save Changes**. + + Back in the setup wizard, fill in the following fields: + - **GitLab instance URL**: Leave blank for `gitlab.com`, or enter your self-hosted instance URL (for example, `https://gitlab.your-domain.com`). Your instance must be publicly accessible for Mintlify to reach it. + - **Project ID**: The project ID from your GitLab project settings. + - **GitLab deployment token**: The access token you generated. + - **Branch**: Select the branch to deploy your documentation from. + + Click **Connect**. The GitLab configuration panel in the Git Settings page of the Mintlify dashboard. The GitLab configuration panel in the Git Settings page of the Mintlify dashboard. @@ -51,6 +65,10 @@ Mintlify uses access tokens and webhooks to authenticate and sync changes betwee +### Update an existing connection + +To modify your GitLab connection settings after the initial setup, go to [Git Settings](https://dashboard.mintlify.com/settings/deployment/git-settings) and update your project ID, access token, branch, or instance URL directly. + ## Create the webhook Webhooks notify Mintlify when you push changes so that deployments trigger