Devx2820 relay governance

docs/developer-community/developer-community-ms-teams-guide.md

@@ -139,7 +139,8 @@ Common purposes include:
 * **alerts** - Notices, maintenance updates and planned outages
 * **emergencyhelp** - Urgent issues only
 * **training** - Training related support
-* **communitychat** - Usually only used for non-service channels like General-communitychat-kudos
+* **communitychat** - Usually only used for non-service channels like [General-communitychat-kudos](https://teams.microsoft.com/l/channel/19%3A0e99940131d3460ca765b0004c51cef4%40thread.tacv2/General-communitychat-kudos?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc)
+* **community-of-practice** - Usually only used for non service channels like common technology tools like [Drupal-community-of-practice](https://teams.microsoft.com/l/channel/19%3A60b2606b9151428282e79f0899d1d50e%40thread.tacv2/Drupal-community-of-practice?groupId=a80418da-c27b-406e-89ab-7695b61924d8&tenantId=6fdb5200-3d0d-4a8a-b036-d3685e359adc)
 
 For self-paced training, use hyphenated purposes such as training-selfpaced.
 

docs/webhooks/governance.md

@@ -0,0 +1,66 @@
+# Webhook and workflow governance
+
+Relay is the Developer Experience team (DevX) developed app that provides messaging functionality in Microsoft Teams.
+
+It has two principal components:  
+
+1. An API service that validates incoming data and then posts messages to MS Teams
+2. A MS Teams app installed on a per-Team basis that functions as a credential for the API
+
+The ability to install the MS Teams app is restricted by security group membership.
+
+This document outlines the governance model and responsibility boundaries for Relay, including app ownership, workflow platform dependencies, support expectations and client responsibilities.
+
+## Responsibilities
+### DevX team
+The **DevX team** is responsible for:
+
+* Developing and maintaining Relay application code
+* Supporting the Relay API hosted in the OpenShift Gold DR environment
+* (dbl check this) Maintaining connectivity to the DevX instance of the workflow service, provided by the Workflows team
+* Onboarding clients and managing security group membership
+* Maintaining support material including:
+  * Keeping support scripts with 77000 service desk current
+  * Relay-specific support and user education for workflow integration
+  * Related web content on DevHub (developer.gov.bc.ca)
+
+### Teams Service Delivery team
+The **Teams Service Delivery team** is responsible for:
+
+* Maintaining MS Teams as an enterprise core service
+* Gatekeeping, publishing and updating Teams apps, including the Relay app
+
+### Workflows team
+The **Workflows** team is responsible for:
+
+* Maintaining the underlying workflow service used by Relay
+* Providing and supporting the DevX instance of the workflow service with high availability
+* Providing general support and user education for the workflow service
+* Supporting DevX team as needed to maintain end-to-end webhook functionality in Teams
+
+### Relay users and clients
+**Relay users and clients** are responsible for:
+
+* Maintaining their product listing and keeping current contacts with the DevX team’s client listing
+* Using Relay only for agreed-upon Teams and channels, in collaboration with DevX team
+* Maintaining their own workflows in the workflow service
+* Ensuring webhook payloads and workflow logic are appropriate for the intended Teams channel
+
+## Support model
+
+Relay support follows a shared responsibility model.
+
+The DevX team provides support for Relay onboarding, API service, Teams webhook integration and Relay troubleshooting.
+
+The Workflows team provides support for the underlying workflow platform, including workflow service availability, platform issues and general workflow guidance.
+
+Relay users are responsible for maintaining their own workflow logic, validating payloads from source systems and ensuring messages are posted only to approved Teams channels.
+
+Issues that cannot be neatly attributed to a single area should be triaged collaboratively by DevX and Workflows.
+
+## Related information 
+
+* [Onboarding guide: Microsoft Teams webhook integration](../webhooks/msteams-webhooks.md)
+* [Install Relay and create your first workflow](../webhooks/create-workflow.md)
+* [Troubleshooting webhook guide](../webhooks/troubleshooting.md)
+

docs/webhooks/troubleshooting.md

@@ -1,4 +1,4 @@
-# Troubleshooting
+# Troubleshooting webhook guide
 
 This guide addresses common issues encountered when integrating the Relay app and n8n workflows. It covers workflow execution failures, message delivery problems, and payload format mismatches. Use this reference to diagnose and resolve issues. 
 

mkdocs.yml

@@ -56,7 +56,8 @@ nav:
   - Relay app and webhook integration: 
     - Onboarding guide:Microsoft Teams Webhook Integration: webhooks/msteams-webhooks.md
     - Install Relay and create your first workflow: webhooks/create-workflow.md
-    - Troubleshooting guide: webhooks/troubleshooting.md
+    - Troubleshooting webhook guide: webhooks/troubleshooting.md
+    - Webhook and workflow governance: webhooks/governance.md
 
   - Quickstart Wizards:
     - Quickstart for OpenShift Wizard: wizards/quickstart-for-openshift-wizard.md