diff --git a/deploy/gitlab.mdx b/deploy/gitlab.mdx index eccbd3c45..751c5a67b 100644 --- a/deploy/gitlab.mdx +++ b/deploy/gitlab.mdx @@ -1,20 +1,16 @@ --- title: "GitLab" description: "Connect to a GitLab repository for automated deployments and preview builds." -keywords: ["GitLab integration", "access tokens", "merge request previews"] +keywords: ["GitLab integration", "access tokens", "merge request previews", "self-hosted", "instance"] --- -We use access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. +Mintlify uses access tokens and webhooks to authenticate and sync changes between GitLab and Mintlify. - 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. +- GitLab uses webhooks to notify Mintlify when you make changes, which enables preview deployments for merge requests. ## Set up the connection - - **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. - - In your GitLab project, navigate to **Settings** > **General** and locate your **Project ID**. @@ -44,8 +40,10 @@ We use access tokens and webhooks to authenticate and sync changes between GitLa 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**. + 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**. 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. diff --git a/images/gitlab/gitlab-config-dark.png b/images/gitlab/gitlab-config-dark.png index 3a5191017..c5d4ecbf1 100644 Binary files a/images/gitlab/gitlab-config-dark.png and b/images/gitlab/gitlab-config-dark.png differ diff --git a/images/gitlab/gitlab-config-light.png b/images/gitlab/gitlab-config-light.png index a781c6f27..bcfcd55ea 100644 Binary files a/images/gitlab/gitlab-config-light.png and b/images/gitlab/gitlab-config-light.png differ