From c0161056f2807be49d581916671be44f9b22559a Mon Sep 17 00:00:00 2001 From: Mark Lewis <lewis@hashicorp.com> Date: Tue, 18 Mar 2025 17:40:11 +0000 Subject: [PATCH] Update gitlab-com.mdx Updated heading per style guide --- website/docs/cloud-docs/vcs/gitlab-com.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/website/docs/cloud-docs/vcs/gitlab-com.mdx b/website/docs/cloud-docs/vcs/gitlab-com.mdx index e025d809e..12d4859a6 100644 --- a/website/docs/cloud-docs/vcs/gitlab-com.mdx +++ b/website/docs/cloud-docs/vcs/gitlab-com.mdx @@ -25,7 +25,7 @@ The rest of this page explains the GitLab.com versions of these steps. -> **Note:** Alternately, you can skip the OAuth configuration process and authenticate with a personal access token. This requires using HCP Terraform's API. For details, see [the OAuth Clients API page](/terraform/cloud-docs/api-docs/oauth-clients). -## Step 1: On HCP Terraform, Begin Adding a New VCS Provider +## Step 1: On HCP Terraform, begin adding a new VCS provider 1. Go to your organization's settings and then click **Providers**. The **VCS Providers** page appears. @@ -37,7 +37,7 @@ The rest of this page explains the GitLab.com versions of these steps. Leave the page open in a browser tab. In the next step you will copy values from this page, and in later steps you will continue configuring HCP Terraform. -## Step 2: On GitLab, Create a New Application +## Step 2: On GitLab, create a new application 1. In a new browser tab, open [gitlab.com](https://gitlab.com) and log in as whichever account you want HCP Terraform to act as. For most organizations this should be a dedicated service user, but a personal account will also work. @@ -68,7 +68,7 @@ Leave the page open in a browser tab. In the next step you will copy values from 1. Leave this page open in a browser tab. In the next step, you will copy and paste the unique **Application ID** and **Secret.** -## Step 3: On HCP Terraform, Set up Your Provider +## Step 3: On HCP Terraform, set up your provider 1. Enter the **Application ID** and **Secret** from the previous step, as well as an option **Name** for this VCS connection. @@ -76,25 +76,25 @@ Leave the page open in a browser tab. In the next step you will copy values from 1. Click the green **Authorize** button at the bottom of the authorization page. -## Step 4: On HCP Terraform, Configure Advanced Settings (Optional) +## Step 4: On HCP Terraform, configure advanced settings (optional) The settings in this section are optional. The Advanced Settings you can configure are: - **Scope of VCS Provider** - You can configure which workspaces can use repositories from this VCS provider. By default the **All Projects** option is selected, meaning this VCS provider is available to be used by all workspaces in the organization. - **Set up SSH Keypair** - Most organizations will not need to add an SSH key. However, if the organization repositories include Git submodules that can only be accessed via SSH, an SSH key can be added along with the OAuth credentials. You can add or update the SSH key at a later time. -### If You Don't Need to Configure Advanced Settings: +### If you do not need to configure advanced settings: 1. Click the **Skip and Finish** button. This returns you to HCP Terraform's VCS Provider page, which now includes your new GitLab client. -### If You Need to Limit the Scope of this VCS Provider: +### If you need to limit the scope of this VCS provider: 1. Select the **Selected Projects** option and use the text field that appears to search for and select projects to enable. All current and future workspaces for any selected projects can use repositories from this VCS Provider. 1. Click the **Update VCS Provider** button to save your selections. -### If You Do Need an SSH Keypair: +### If uou do need an SSH keypair: -#### Important Notes +#### Important notes - SSH will only be used to clone Git submodules. All other Git operations will still use HTTPS. - Do not use your personal SSH key to connect HCP Terraform and GitLab; generate a new one or use an existing key reserved for service access.