From cf310f3098e4b9fc547b217fffa6670b6f75b43e Mon Sep 17 00:00:00 2001 From: Marcin Jasion <5058132+mjasion@users.noreply.github.com> Date: Wed, 12 Jun 2024 17:28:03 +0200 Subject: [PATCH] feat(scm): Update SCM settings examples (#5262) Our examples were outdated, and made confusion to our client. Co-authored-by: Marcin Jasion --- .../configuration/git-forges/github.md | 11 +++---- .../configuration/git-forges/gitlab.md | 29 ++++++++++--------- 2 files changed, 21 insertions(+), 19 deletions(-) diff --git a/content/docs/studio/self-hosting/configuration/git-forges/github.md b/content/docs/studio/self-hosting/configuration/git-forges/github.md index 2e6bab187b..bec5c35b2a 100644 --- a/content/docs/studio/self-hosting/configuration/git-forges/github.md +++ b/content/docs/studio/self-hosting/configuration/git-forges/github.md @@ -50,6 +50,12 @@ marked with `<>` with the values the steps above: ```yaml global: scmProviders: + # Optional + # This is useful in cases where DVC Studio is on an internal + # network, but the webhook endpoint is on an external network. + # Default: `global.host` value. + #webhookHost: "" + github: enabled: true @@ -63,9 +69,4 @@ global: clientId: clientSecret: privateKey: - - # Optional - # This is useful in cases where DVC Studio is on an internal - # network, but the webhook endpoint is on an external network - # webhookUrl: https://webhook.studio.company.com/webhook/github/ ``` diff --git a/content/docs/studio/self-hosting/configuration/git-forges/gitlab.md b/content/docs/studio/self-hosting/configuration/git-forges/gitlab.md index b1f0b4b10c..19b9fa9753 100644 --- a/content/docs/studio/self-hosting/configuration/git-forges/gitlab.md +++ b/content/docs/studio/self-hosting/configuration/git-forges/gitlab.md @@ -30,22 +30,23 @@ got created: Merge the `values.yaml` file with the following contents: ```yaml -scmProviders: - gitlab: - enabled: true - - # Set this if you're hosting GitLab on a - # custom domain - url: '' - - clientId: - secretKey: - webhookSecret: - +global: + scmProviders: # Optional # This is useful in cases where DVC Studio is on an internal - # network, but the webhook endpoint is on an external network - # webhookUrl: https://webhook.studio.company.com/webhook/gitlab/ + # network, but the webhook endpoint is on an external network. + # Default: `global.host` value. + #webhookHost: "" + gitlab: + enabled: true + + # Set this if you're hosting GitLab on a + # custom domain + url: + + clientId: + secretKey: + webhookSecret: ```