docs(customization): added support configuration guide (janus-idp#962)

* docs(customization): added support configuration guide Signed-off-by: Yi Cai <[email protected]> * Updated image width Signed-off-by: Yi Cai <[email protected]> * Updated example Signed-off-by: Yi Cai <[email protected]> --------- Signed-off-by: Yi Cai <[email protected]>
davidfestal · Feb 14, 2024 · ba3500b · ba3500b
1 parent 1cb3eba
commit ba3500b
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/showcase-docs/customization.md b/showcase-docs/customization.md
@@ -106,3 +106,32 @@ app:
 
 ![Example Light Mode Sidebar Indicator](images/example-sidebar-indicator-light.png)
 ![Example Dark Mode Sidebar Indicator](images/example-sidebar-indicator-dark.png)
+
+## Customizing Support button content
+
+To customize the Support button content, provide your support team links and icons to the `app.support` field of the `app-config.yaml` file.
+
+Example configurations:
+
+```
+app:
+  support:
+    url: https://github.com/janus-idp/backstage-showcase/issues # Used as contact support link on common ErrorPage
+    items:                                                      # Used by common SupportButton component
+      - title: Issues
+        icon: github
+        links:
+          - url: https://github.com/janus-idp/backstage-showcase/issues
+            title: GitHub Issues
+      - title: Join the community
+        icon: chat
+        links:
+          - url: https://janus-idp.io/community/
+            title: Janus Community
+```
+
+<img src="images/example-support-button.png" alt="Example Support Configured" width="285">
+
+If support is not configured, it would look as below.
+
+<img src="images/support-not-configured.png" alt="Example Support Not Configured" width="285">
diff --git a/showcase-docs/images/example-support-button.png b/showcase-docs/images/example-support-button.png
diff --git a/showcase-docs/images/support-not-configured.png b/showcase-docs/images/support-not-configured.png