Merge pull request #2 from adinhodovic/update-docs

docs: Update documentation
adinhodovic · Nov 13, 2023 · 306aafe · 306aafe
2 parents d2192b8 + df01230
commit 306aafe
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -48,3 +48,13 @@ monitoring stack.
 ## Alerts
 
 The mixin follows the [monitoring-mixins guidelines](https://github.com/monitoring-mixins/docs#guidelines-for-alert-names-labels-and-annotations) for alerts.
+
+## Preview
+
+### Application Dashboard
+
+![argo-cd-application-overview](images/argo-cd-application-overview.png)
+
+### Notification Dashboard
+
+![argo-cd-notifications-overview](images/argo-cd-notifications-overview.png)
diff --git a/config.libsonnet b/config.libsonnet
@@ -3,6 +3,12 @@ local annotation = g.dashboard.annotation;
 
 {
   _config+:: {
+    // Bypasses grafana.com/dashboards validator
+    bypassDashboardValidation: {
+      __inputs: [],
+      __requires: [],
+    },
+
     argoCdSelector: 'job=~".*"',
 
     grafanaUrl: 'https://grafana.com',

diff --git a/dashboards/argo-cd-applications.libsonnet b/dashboards/argo-cd-applications.libsonnet
@@ -668,10 +668,11 @@ local tbOverride = tbStandardOptions.override;
       ),
 
     'argo-cd-application-overview.json':
+      $._config.bypassDashboardValidation +
       dashboard.new(
         'ArgoCD / Application / Overview',
       ) +
-      dashboard.withDescription('A dashboard that monitors ArgoCD with a focus on Application status. It is created using the [argo-cd-mixin](https://github.com/adinhodovic/argo-cd-mixin).') +
+      dashboard.withDescription('A dashboard that monitors ArgoCD with a focus on Application status. It is created using the [argo-cd-mixin](https://github.com/adinhodovic/argo-cd-mixin). Requires custom configuration to add application badges. Please refer to the mixin.') +
       dashboard.withUid($._config.applicationOverviewDashboardUid) +
       dashboard.withTags($._config.tags) +
       dashboard.withTimezone('utc') +

diff --git a/dashboards/argo-cd-notifications.libsonnet b/dashboards/argo-cd-notifications.libsonnet
@@ -158,6 +158,7 @@ local tsLegend = tsOptions.legend;
       ),
 
     'argo-cd-notifications-overview.json':
+      $._config.bypassDashboardValidation +
       dashboard.new(
         'ArgoCD / Notifications / Overview',
       ) +

diff --git a/dashboards_out/argo-cd-application-overview.json b/dashboards_out/argo-cd-application-overview.json
@@ -1,5 +1,7 @@
 {
-   "description": "A dashboard that monitors ArgoCD with a focus on Application status. It is created using the [argo-cd-mixin](https://github.com/adinhodovic/argo-cd-mixin).",
+   "__inputs": [ ],
+   "__requires": [ ],
+   "description": "A dashboard that monitors ArgoCD with a focus on Application status. It is created using the [argo-cd-mixin](https://github.com/adinhodovic/argo-cd-mixin). Requires custom configuration to add application badges. Please refer to the mixin.",
    "editable": true,
    "panels": [
       {

diff --git a/dashboards_out/argo-cd-notifications-overview.json b/dashboards_out/argo-cd-notifications-overview.json
@@ -1,4 +1,6 @@
 {
+   "__inputs": [ ],
+   "__requires": [ ],
    "description": "A dashboard that monitors ArgoCD notifications. It is created using the [argo-cd-mixin](https://github.com/adinhodovic/argo-cd-mixin).",
    "editable": true,
    "panels": [

diff --git a/images/argo-cd-application-overview.png b/images/argo-cd-application-overview.png
diff --git a/images/argo-cd-notifications-overview.png b/images/argo-cd-notifications-overview.png