Add an example for branding site configuration (#3780)

This adds an example to the schema for the `branding` property to showcase on the docs page how to use it.
sourcegraph · May 3, 2019 · 4966a7f · 4966a7f
1 parent 3904150
commit 4966a7f
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 4 deletions.
diff --git a/schema/schema.go b/schema/schema.go
diff --git a/schema/site.schema.json b/schema/site.schema.json
@@ -151,7 +151,7 @@
       "group": "Security"
     },
     "branding": {
-      "description": "Customize Sourcegraph homepage logo and search icon.",
+      "description": "Customize Sourcegraph homepage logo and search icon.\n\nOnly available in Sourcegraph Enterprise.",
       "type": "object",
       "additionalProperties": false,
       "properties": {
@@ -166,7 +166,20 @@
           "type": "string",
           "format": "uri"
         }
-      }
+      },
+      "examples": [
+        {
+          "favicon": "https://example.com/favicon.ico",
+          "light": {
+            "logo": "https://example.com/logo_light.png",
+            "symbol": "https://example.com/search_symbol_light_24x24.png"
+          },
+          "dark": {
+            "logo": "https://example.com/logo_dark.png",
+            "symbol": "https://example.com/search_symbol_dark_24x24.png"
+          }
+        }
+      ]
     },
     "email.smtp": {
       "title": "SMTPServerConfig",

diff --git a/schema/site_stringdata.go b/schema/site_stringdata.go