feat(scm): Update SCM settings examples (#5262)

Our examples were outdated, and made confusion to our client. Co-authored-by: Marcin Jasion <[email protected]>
iterative · Jun 12, 2024 · cf310f3 · cf310f3
1 parent bd6ffaf
commit cf310f3
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 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
@@ -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: <GitHub OAuth App Client ID>
       clientSecret: <GitHub OAuth App Client Secret>
       privateKey: <GitHub OAuth App Private Key>
-
-      # 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
@@ -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: <GitLab OAuth App Client ID>
-    secretKey: <GitLab OAuth App Secret Key>
-    webhookSecret: <GitLab Webhook Secret>
-
+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: <GitLab URL>
+
+      clientId: <GitLab OAuth App Client ID>
+      secretKey: <GitLab OAuth App Secret Key>
+      webhookSecret: <GitLab Webhook Secret>
 ```
 
 <admon type="info">