Skip to content

Commit 1746528

Browse files
authored
Relocate Grafana Helm Setup doc onto Getting Started (#270)
1 parent ea2dd24 commit 1746528

File tree

2 files changed

+6
-23
lines changed

2 files changed

+6
-23
lines changed

docs/03-concepts/12-grafana-helm-setup.md renamed to docs/01-get-started/05-grafana-helm-setup.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
---
22
layout: default
33
title: Grafana Helm Setup
4-
permalink: /docs/concepts/grafana-helm-setup
4+
permalink: /docs/get-started/grafana-helm-setup
55
---
66

77
# Grafana Helm Setup
88

9-
<details>
10-
<summary><h2>Introduction</h2></summary>
11-
129
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.
1310

14-
</details>
15-
16-
<details>
17-
<summary><h2>Prerequisites</h2></summary>
11+
## Prerequisites
1812

1913
Before proceeding, ensure the following:
2014

2115
- Kubernetes cluster is up and running.
2216
- Helm is installed on your system. Refer to the [Helm installation guide](https://helm.sh/docs/intro/install/).
2317
- Access to the Cadence Helm charts repository.
2418

25-
</details>
26-
27-
<details>
28-
<summary><h2>Setup Steps</h2></summary>
19+
## Setup Steps
2920

3021
### Step 1: Add Cadence Helm Repository
3122

@@ -108,10 +99,7 @@ curl https://raw.githubusercontent.com/cadence-workflow/cadence/refs/heads/maste
10899
3. **Select Prometheus** as data source when prompted
109100
4. Try the same steps for other dashboards
110101

111-
</details>
112-
113-
<details>
114-
<summary><h2>Customization</h2></summary>
102+
## Customization
115103

116104
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.
117105

@@ -129,13 +117,8 @@ Install Grafana with the custom values:
129117
helm install grafana cadence/grafana -n cadence-monitoring -f values.yaml
130118
```
131119

132-
</details>
133-
134-
<details>
135-
<summary><h2>Additional Information</h2></summary>
120+
## Additional Information
136121

137122
- [Cadence Helm Charts Repository](https://github.com/cadence-workflow/cadence-charts)
138123
- [Grafana Documentation](https://grafana.com/docs/)
139124
- [Helm Documentation](https://helm.sh/docs/)
140-
141-
</details>

sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ const sidebars: SidebarsConfig = {
2424
{ type: 'doc', id: 'get-started/java-hello-world' },
2525
{ type: 'doc', id: 'get-started/golang-hello-world' },
2626
{ type: 'doc', id: 'get-started/video-tutorials' },
27+
{ type: 'doc', id: 'get-started/grafana-helm-setup' },
2728
],
2829
},
2930
{
@@ -62,7 +63,6 @@ const sidebars: SidebarsConfig = {
6263
{ type: 'doc', id: 'concepts/search-workflows' },
6364
{ type: 'doc', id: 'concepts/http-api' },
6465
{ type: 'doc', id: 'concepts/data-converter' },
65-
{ type: 'doc', id: 'concepts/grafana-helm-setup' },
6666
{ type: 'doc', id: 'concepts/workflow-queries-formatted-data' },
6767
],
6868
},

0 commit comments

Comments
 (0)