Skip to content

Commit b311f59

Browse files
authored
📝 Doc: add docsify documentation (#102)
1 parent a8845f5 commit b311f59

9 files changed

+317
-6
lines changed

README.md

+12-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
# Databricks - Grafana Data Source Backend Plugin
22

3+
![GitHub Release](https://img.shields.io/github/v/release/mullerpeter/databricks-grafana)
4+
[![Github All Releases](https://img.shields.io/github/downloads/mullerpeter/databricks-grafana/total.svg)]()
35
![Release workflow](https://github.com/mullerpeter/databricks-grafana/actions/workflows/release.yml/badge.svg)
46

57
Grafana Databricks integration allowing direct connection to Databricks to query and visualize Databricks data in Grafana.
68

79
![img.png](img/full_text_sql_editor.png)
810

11+
## Documentation
12+
13+
Read the full [Grafana Data Source Backend Plugin Documentation](https://mullerpeter.github.io/databricks-grafana) for more information.
14+
915
## Get started with the plugin
1016

1117
### Set up the Databricks Data Source
@@ -21,11 +27,11 @@ If you are using an earlier Grafana version try one of the following Plugin Vers
2127
#### Install the Data Source
2228

2329
1. Install the plugin into the grafana plugin folder:
24-
```shell
30+
```bash
2531
grafana-cli --pluginUrl https://github.com/mullerpeter/databricks-grafana/releases/latest/download/mullerpeter-databricks-datasource.zip plugins install mullerpeter-databricks-datasource
2632
```
2733
or
28-
```shell
34+
```bash
2935
cd /var/lib/grafana/plugins/
3036
wget https://github.com/mullerpeter/databricks-grafana/releases/latest/download/mullerpeter-databricks-datasource.zip
3137
unzip mullerpeter-databricks-datasource.zip
@@ -34,12 +40,12 @@ unzip mullerpeter-databricks-datasource.zip
3440
2. Edit the grafana configuration file to allow unsigned plugins:
3541
* Linux:/etc/grafana/grafana.ini
3642
* macOS:/usr/local/etc/grafana/grafana.ini
37-
```shell
43+
```ini
3844
[plugins]
3945
allow_loading_unsigned_plugins = mullerpeter-databricks-datasource
4046
```
4147
Or with docker
42-
```shell
48+
```bash
4349
docker run -d \
4450
-p 3000:3000 \
4551
-v "$(pwd)"/grafana-plugins:/var/lib/grafana/plugins \
@@ -173,7 +179,7 @@ Both the Visual Query Builder and the Code Editor support the transformation of
173179
### Examples
174180
#### Single Value Time Series
175181

176-
```sparksql
182+
```sql
177183
SELECT
178184
window.start,
179185
avg(value_column)
@@ -186,7 +192,7 @@ GROUP BY
186192
```
187193
#### Multiple Values Time Series
188194

189-
```sparksql
195+
```sql
190196
SELECT
191197
window.start,
192198
avg(CAST(o_totalprice AS DOUBLE)),

docs/.nojekyll

Whitespace-only changes.

docs/README.md

+278
Large diffs are not rendered by default.

docs/img/code_query_editor.png

119 KB
Loading

docs/img/config_editor.png

166 KB
Loading

docs/img/databricks_logo.png

19.6 KB
Loading

docs/img/full_text_sql_editor.png

268 KB
Loading

docs/img/visual_query_editor.png

194 KB
Loading

docs/index.html

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<title>Document</title>
6+
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
7+
<meta name="description" content="Description">
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
9+
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
10+
</head>
11+
<body>
12+
<div id="app"></div>
13+
<script>
14+
window.$docsify = {
15+
name: 'Databricks - Grafana Data Source Backend Plugin',
16+
repo: 'https://github.com/mullerpeter/databricks-grafana'
17+
}
18+
</script>
19+
<!-- Docsify v4 -->
20+
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
21+
<script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-bash.min.js"></script>
22+
<script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-sql.min.js"></script>
23+
<script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-yaml.min.js"></script>
24+
<script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-ini.min.js"></script>
25+
<script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
26+
</body>
27+
</html>

0 commit comments

Comments
 (0)