diff --git a/docs/03-concepts/12-grafana-helm-setup.md b/docs/01-get-started/05-grafana-helm-setup.md similarity index 90% rename from docs/03-concepts/12-grafana-helm-setup.md rename to docs/01-get-started/05-grafana-helm-setup.md index 910c319b6..b79255193 100644 --- a/docs/03-concepts/12-grafana-helm-setup.md +++ b/docs/01-get-started/05-grafana-helm-setup.md @@ -1,20 +1,14 @@ --- layout: default title: Grafana Helm Setup -permalink: /docs/concepts/grafana-helm-setup +permalink: /docs/get-started/grafana-helm-setup --- # Grafana Helm Setup -
-

Introduction

- This guide explains how to set up Grafana for monitoring Cadence workflows and services using Helm charts. Helm simplifies the deployment and management of Grafana in Kubernetes environments. Pre-configured dashboards for Cadence are available to visualize metrics effectively. -
- -
-

Prerequisites

+## Prerequisites Before proceeding, ensure the following: @@ -22,10 +16,7 @@ Before proceeding, ensure the following: - Helm is installed on your system. Refer to the [Helm installation guide](https://helm.sh/docs/intro/install/). - Access to the Cadence Helm charts repository. -
- -
-

Setup Steps

+## Setup Steps ### Step 1: Add Cadence Helm Repository @@ -108,10 +99,7 @@ curl https://raw.githubusercontent.com/cadence-workflow/cadence/refs/heads/maste 3. **Select Prometheus** as data source when prompted 4. Try the same steps for other dashboards -
- -
-

Customization

+## Customization The Grafana dashboards can be customized by editing the JSON files or modifying panels directly in Grafana. Additionally, Helm values can be overridden during installation to customize Grafana settings. @@ -129,13 +117,8 @@ Install Grafana with the custom values: helm install grafana cadence/grafana -n cadence-monitoring -f values.yaml ``` -
- -
-

Additional Information

+## Additional Information - [Cadence Helm Charts Repository](https://github.com/cadence-workflow/cadence-charts) - [Grafana Documentation](https://grafana.com/docs/) - [Helm Documentation](https://helm.sh/docs/) - -
diff --git a/sidebars.ts b/sidebars.ts index 64bed64cd..35745771e 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -24,6 +24,7 @@ const sidebars: SidebarsConfig = { { type: 'doc', id: 'get-started/java-hello-world' }, { type: 'doc', id: 'get-started/golang-hello-world' }, { type: 'doc', id: 'get-started/video-tutorials' }, + { type: 'doc', id: 'get-started/grafana-helm-setup' }, ], }, { @@ -62,7 +63,6 @@ const sidebars: SidebarsConfig = { { type: 'doc', id: 'concepts/search-workflows' }, { type: 'doc', id: 'concepts/http-api' }, { type: 'doc', id: 'concepts/data-converter' }, - { type: 'doc', id: 'concepts/grafana-helm-setup' }, { type: 'doc', id: 'concepts/workflow-queries-formatted-data' }, ], },