From 5fccc38631c40d5a8c0ed0271e5092d98c73105c Mon Sep 17 00:00:00 2001 From: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> Date: Wed, 22 Nov 2023 17:42:48 +0530 Subject: [PATCH 1/4] Update README.md Signed-off-by: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> --- dashboards/grafana/README.md | 40 ++++++------------------------------ 1 file changed, 6 insertions(+), 34 deletions(-) diff --git a/dashboards/grafana/README.md b/dashboards/grafana/README.md index 065611915d..2cff208378 100644 --- a/dashboards/grafana/README.md +++ b/dashboards/grafana/README.md @@ -1,39 +1,11 @@ -# Grafana Dashboards for the Lifecycle Toolkit +# Grafana Dashboards for Keptn -This folder contains the Grafana dashboards for the Keptn Lifecycle Toolkit. +This section provides guidance on creating and modifying custom dashboards using Grafana. -## Installing the dashboards +## How to Create Custom Dashboards -It is assumed, that there is a Grafana Instance available. -In our provided examples, the dashboards are automatically -provisioned. -If you want to install the dashboards manually, you can use the following steps: +Craft personalized Grafana dashboards tailored to your specific needs by exploring the [official Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/create-dashboard/). Discover detailed steps, best practices, and tips for creating visualizations, adding panels, utilizing various data sources, and more. -```shell -# This defaults to http://localhost:3000, but can be changed by setting the GRAFANA_SCHEME, GRAFANA_URL and GRAFANA_PORT environment variable -# The default credentials are admin:admin, but can be changed by setting the GRAFANA_USERNAME and GRAFANA_PASSWORD environment variable -make install -``` +## Modifying the Dashboards -## Changing the dashboards - -The dashboards can be changed in the Grafana UI. -To export dashboards, export them using the share button and replace -them in this folder. - -## Exporting the dashboards for the Examples - -You can import the default dashboards by running: - -```shell -make apply-configmaps -``` - -If you prefer to prepare the dashboards for the examples and importing them as json you can use: - -```shell -make import-json -``` - - - +Refine and adapt visualizations in existing Grafana dashboards to meet evolving requirements. Visit the [relevant sections](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/modify-dashboard-settings/) of the Grafana documentation to gain insights on adjusting, enhancing, or reconfiguring dashboards efficiently. Learn about editing panels, incorporating new data sources, applying filters, and optimizing dashboard layouts. From 56984405c1e0e9b106c2010e1bad3103db43dcf6 Mon Sep 17 00:00:00 2001 From: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> Date: Thu, 23 Nov 2023 23:28:01 +0530 Subject: [PATCH 2/4] Updated README; added issued changes at the end of the file. Signed-off-by: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> --- dashboards/grafana/README.md | 48 ++++++++++++++++++++++++++++++++++-- 1 file changed, 46 insertions(+), 2 deletions(-) diff --git a/dashboards/grafana/README.md b/dashboards/grafana/README.md index 2cff208378..8f4eb94b63 100644 --- a/dashboards/grafana/README.md +++ b/dashboards/grafana/README.md @@ -1,6 +1,48 @@ -# Grafana Dashboards for Keptn +# Grafana Dashboards for the Lifecycle Toolkit -This section provides guidance on creating and modifying custom dashboards using Grafana. +This folder contains the Grafana dashboards for the Keptn Lifecycle Toolkit. + +## Installing the dashboards + +It is assumed, that there is a Grafana Instance available. +In our provided examples, the dashboards are automatically +provisioned. +If you want to install the dashboards manually, you can use the following steps: + +```shell +# This defaults to http://localhost:3000, but can be changed by setting the GRAFANA_SCHEME, GRAFANA_URL and GRAFANA_PORT environment variable +# The default credentials are admin:admin, but can be changed by setting the GRAFANA_USERNAME and GRAFANA_PASSWORD environment variable +make install +``` + +## Changing the dashboards + +The dashboards can be changed in the Grafana UI. +To export dashboards, export them using the share button and replace +them in this folder. + +## Exporting the dashboards for the Examples + +You can import the default dashboards by running: + +```shell +make apply-configmaps +``` + +If you prefer to prepare the dashboards for the examples and importing them as json you can use: + +```shell +make import-json +``` + + + + +--- + +# Guide to Custom Dashboards with Grafana + +This section provides links to the official Grafana documentation for creating and modifying custom dashboards using Grafana. ## How to Create Custom Dashboards @@ -9,3 +51,5 @@ Craft personalized Grafana dashboards tailored to your specific needs by explori ## Modifying the Dashboards Refine and adapt visualizations in existing Grafana dashboards to meet evolving requirements. Visit the [relevant sections](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/modify-dashboard-settings/) of the Grafana documentation to gain insights on adjusting, enhancing, or reconfiguring dashboards efficiently. Learn about editing panels, incorporating new data sources, applying filters, and optimizing dashboard layouts. + + From 7db12f4c09edfb92c680710daa9f61e402d7e86d Mon Sep 17 00:00:00 2001 From: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> Date: Fri, 1 Dec 2023 18:05:06 +0530 Subject: [PATCH 3/4] Added new content to the end of the document and corrected linting errors Signed-off-by: UtkarshUmre <112888849+UtkarshUmre@users.noreply.github.com> --- dashboards/grafana/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/dashboards/grafana/README.md b/dashboards/grafana/README.md index 6d30e00fc4..4ce789fba1 100644 --- a/dashboards/grafana/README.md +++ b/dashboards/grafana/README.md @@ -34,3 +34,17 @@ If you prefer to prepare the dashboards for the examples and importing them as j ```shell make import-json ``` + +--- + +## Guide to Custom Dashboards with Grafana + +This section provides links to the official Grafana documentation for creating and modifying custom dashboards using Grafana. + +## How to Create Custom Dashboards + +Craft personalized Grafana dashboards tailored to your specific needs by exploring the [official Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/create-dashboard/). Discover detailed steps, best practices, and tips for creating visualizations, adding panels, utilizing various data sources, and more. + +## Modifying the Dashboards + +Refine and adapt visualizations in existing Grafana dashboards to meet evolving requirements. Visit the [relevant sections](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/modify-dashboard-settings/) of the Grafana documentation to gain insights on adjusting, enhancing, or reconfiguring dashboards efficiently. Learn about editing panels, incorporating new data sources, applying filters, and optimizing dashboard layouts. From ae2832d95c3d5ce2a34c9a17dc858a7536a21938 Mon Sep 17 00:00:00 2001 From: Moritz Wiesinger Date: Mon, 4 Dec 2023 13:48:55 +0100 Subject: [PATCH 4/4] fix rest of linting errors Signed-off-by: Moritz Wiesinger --- .markdownlint-cli2.yaml | 1 + dashboards/grafana/README.md | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.markdownlint-cli2.yaml b/.markdownlint-cli2.yaml index 24d8951527..0065b490bb 100644 --- a/.markdownlint-cli2.yaml +++ b/.markdownlint-cli2.yaml @@ -18,3 +18,4 @@ ignores: - "**/CHANGELOG.md" - "node_modules" - "docs/tmp" + - "readme-generator-for-helm" diff --git a/dashboards/grafana/README.md b/dashboards/grafana/README.md index 149f256e3e..7facff69d4 100644 --- a/dashboards/grafana/README.md +++ b/dashboards/grafana/README.md @@ -43,9 +43,14 @@ This section provides links to the official Grafana documentation for creating a ## How to Create Custom Dashboards -Craft personalized Grafana dashboards tailored to your specific needs by exploring the [official Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/create-dashboard/). Discover detailed steps, best practices, and tips for creating visualizations, adding panels, utilizing various data sources, and more. +Craft personalized Grafana dashboards tailored to your specific needs by exploring the [official Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/create-dashboard/). +Discover detailed steps, best practices, and tips for creating visualizations, adding panels, +utilizing various data sources, and more. ## Modifying the Dashboards -Refine and adapt visualizations in existing Grafana dashboards to meet evolving requirements. Visit the [relevant sections](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/modify-dashboard-settings/) of the Grafana documentation to gain insights on adjusting, enhancing, or reconfiguring dashboards efficiently. Learn about editing panels, incorporating new data sources, applying filters, and optimizing dashboard layouts. - +Refine and adapt visualizations in existing Grafana dashboards to meet evolving requirements. +Visit the +[relevant sections](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/modify-dashboard-settings/) +of the Grafana documentation to gain insights on adjusting, enhancing, or reconfiguring dashboards efficiently. +Learn about editing panels, incorporating new data sources, applying filters, and optimizing dashboard layouts.