From 341c90aa4da8ad2b772643aa8da83a9b9302d762 Mon Sep 17 00:00:00 2001
From: Monty Taylor <mordred@inaugust.com>
Date: Wed, 20 May 2020 17:04:36 -0500
Subject: [PATCH] Add descriptions to the different dashboard jobs

Change-Id: I417614bdd86b4a9345ba43a446b61505ac213973
---
 .zuul.yaml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/.zuul.yaml b/.zuul.yaml
index 43c64a6b5b..56b0e527d6 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -75,6 +75,8 @@
 - job:
     name: zuul-build-dashboard
     parent: build-javascript-deployment
+    description: |
+      Builds the zuul dashboard without an overridden API URL.
     success-url: 'npm/html/'
     files:
       - web/.*
@@ -88,18 +90,34 @@
 - job:
     name: zuul-build-dashboard-openstack-whitelabel
     parent: zuul-build-dashboard
+    description: |
+      Builds the zuul dashboard with API URL pointing to
+      https://zuul.openstack.org, which tests whitelabeled
+      deployments.
     vars:
       zuul_api_url: https://zuul.openstack.org
 
 - job:
     name: zuul-build-dashboard-software-factory
     parent: zuul-build-dashboard
+    description: |
+      Builds the zuul dashboard with API URL pointing to
+      https://softwarefactory-project.io/zuul, which tests
+      multi-tenant deployments on a suburl, as well as letting
+      us check that dashboard changes won't break the
+      softwarefactory service.
     vars:
       zuul_api_url: https://softwarefactory-project.io/zuul
 
 - job:
     name: zuul-build-dashboard-opendev
     parent: zuul-build-dashboard
+    description: |
+      Builds the zuul dashboard with API URL pointing to
+      https://zuul.opendev.org, which tests multi-tenant
+      deployments not on a suburl, as well as letting us
+      check that dashboard changes won't break the
+      OpenDev service.
     vars:
       zuul_api_url: https://zuul.opendev.org