mullerpeter · mullerpeter · Nov 17, 2024 · Nov 17, 2024
diff --git a/README.md b/README.md
@@ -1,11 +1,17 @@
 # Databricks - Grafana Data Source Backend Plugin
 
+![GitHub Release](https://img.shields.io/github/v/release/mullerpeter/databricks-grafana)
+[![Github All Releases](https://img.shields.io/github/downloads/mullerpeter/databricks-grafana/total.svg)]()
 ![Release workflow](https://github.com/mullerpeter/databricks-grafana/actions/workflows/release.yml/badge.svg)
 
 Grafana Databricks integration allowing direct connection to Databricks to query and visualize Databricks data in Grafana.
 
 ![img.png](img/full_text_sql_editor.png)
 
+## Documentation
+
+Read the full [Grafana Data Source Backend Plugin Documentation](https://mullerpeter.github.io/databricks-grafana) for more information.
+
 ## Get started with the plugin
 
 ### 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
 #### Install the Data Source
 
 1. Install the plugin into the grafana plugin folder:
-```shell
+```bash
 grafana-cli --pluginUrl https://github.com/mullerpeter/databricks-grafana/releases/latest/download/mullerpeter-databricks-datasource.zip plugins install mullerpeter-databricks-datasource
 ```
 or
-```shell
+```bash
 cd /var/lib/grafana/plugins/
 wget https://github.com/mullerpeter/databricks-grafana/releases/latest/download/mullerpeter-databricks-datasource.zip
 unzip mullerpeter-databricks-datasource.zip
@@ -34,12 +40,12 @@ unzip mullerpeter-databricks-datasource.zip
 2. Edit the grafana configuration file to allow unsigned plugins:
 * Linux：/etc/grafana/grafana.ini
 * macOS：/usr/local/etc/grafana/grafana.ini
-```shell
+```ini
 [plugins]
 allow_loading_unsigned_plugins = mullerpeter-databricks-datasource
 ```
 Or with docker
-```shell
+```bash
 docker run -d \
 -p 3000:3000 \
 -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
 ### Examples
 #### Single Value Time Series
 
-```sparksql
+```sql
 SELECT
    window.start,
    avg(value_column)
@@ -186,7 +192,7 @@ GROUP BY
 ```
 #### Multiple Values Time Series
 
-```sparksql
+```sql
 SELECT
     window.start,
     avg(CAST(o_totalprice AS DOUBLE)),

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/img/code_query_editor.png b/docs/img/code_query_editor.png
diff --git a/docs/img/config_editor.png b/docs/img/config_editor.png
diff --git a/docs/img/databricks_logo.png b/docs/img/databricks_logo.png
diff --git a/docs/img/full_text_sql_editor.png b/docs/img/full_text_sql_editor.png
diff --git a/docs/img/visual_query_editor.png b/docs/img/visual_query_editor.png
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,27 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Document</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
+</head>
+<body>
+  <div id="app"></div>
+  <script>
+    window.$docsify = {
+      name: 'Databricks - Grafana Data Source Backend Plugin',
+      repo: 'https://github.com/mullerpeter/databricks-grafana'
+    }
+  </script>
+  <!-- Docsify v4 -->
+  <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-bash.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-sql.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-yaml.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/prismjs@1.29.0/components/prism-ini.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>
+</body>
+</html>