From b447019bc816c2f750a17121e3635f99432b32c6 Mon Sep 17 00:00:00 2001
From: royendo <67675319+royendo@users.noreply.github.com>
Date: Fri, 23 May 2025 08:54:08 -0600
Subject: [PATCH] Rill Docs backbone, will update photos and contents next week
---
.../data-visualization/rill-and-clickhouse.md | 85 ++++++++++++++++++
sidebars.js | 7 +-
.../data-visualization/rill/rill_02.png | Bin 0 -> 63791 bytes
.../data-visualization/rill/rill_03.png | Bin 0 -> 63791 bytes
.../data-visualization/rill/rill_04.png | Bin 0 -> 63791 bytes
.../data-visualization/rill/rill_05.png | Bin 0 -> 105818 bytes
.../data-visualization/rill/rill_06.gif.png | Bin 0 -> 105818 bytes
7 files changed, 89 insertions(+), 3 deletions(-)
create mode 100644 docs/integrations/data-visualization/rill-and-clickhouse.md
create mode 100644 static/images/integrations/data-visualization/rill/rill_02.png
create mode 100644 static/images/integrations/data-visualization/rill/rill_03.png
create mode 100644 static/images/integrations/data-visualization/rill/rill_04.png
create mode 100644 static/images/integrations/data-visualization/rill/rill_05.png
create mode 100644 static/images/integrations/data-visualization/rill/rill_06.gif.png
diff --git a/docs/integrations/data-visualization/rill-and-clickhouse.md b/docs/integrations/data-visualization/rill-and-clickhouse.md
new file mode 100644
index 00000000000..6a3ef39f1c4
--- /dev/null
+++ b/docs/integrations/data-visualization/rill-and-clickhouse.md
@@ -0,0 +1,85 @@
+---
+title: 'Connect your ClickHouse Database and Create an Exploratary Dashboard.'
+sidebar_label: 'Rill Data'
+slug: /integrations/rill
+description: 'Rill Data and Clickhouse integration, building fast dashboards on top of ClickHouse'
+keywords: ['clickhouse', 'Rill', 'connect', 'visualization', 'dashboard']
+
+---
+import Image from '@theme/IdealImage';
+import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained';
+import rill_01 from '@site/static/images/integrations/data-visualization/rill/rill_06.gif.png';
+import rill_02 from '@site/static/images/integrations/data-visualization/rill/rill_02.png';
+import rill_03 from '@site/static/images/integrations/data-visualization/rill/rill_03.png';
+import rill_04 from '@site/static/images/integrations/data-visualization/rill/rill_04.png';
+import rill_05 from '@site/static/images/integrations/data-visualization/rill/rill_05.png';
+import rill_06 from '@site/static/images/integrations/data-visualization/rill/rill_06.gif.png';
+
+
+
+
+## Install Rill {#install-rill}
+
+You can install `rill` using our installation script on both macOS and Linux:
+
+```bash
+curl https://rill.sh | sh
+```
+
+
+
+Once installed, you can start Rill by running the following in the CLI, this will automatically open your browser to `localhost:9009`.
+
+```bash
+rill start
+```
+
+## Connect to your ClickHouse Instance {#connect-to-clickhouse}
+
+After starting an empty project, select `+Add`, `Data` and select the ClickHouse Icon. Depending on where your ClickHouse database lives, select the following the dropdown:
+
+### ClickHouse Cloud {#connect-to-clickhouse-cloud}
+
+You'll need to [grab your credential from ClickHouse Cloud](/docs/cloud/get-started/cloud-quick-start#connect-with-your-app) and use this information to connect to Rill!
+
+
+
+:::note Requirements from ClickHouse Cloud
+In order to connect to ClickHouse Cloud, you'll need to check the SSL checkbox.
+:::
+
+### Self hosted ClickHouse {#connect-to-clickhouse-self}
+
+We can also conenct to your self-hosted ClickHouse instance. Fill in the parameters as seen below and click `Connect` to access your ClickHouse database.
+
+
+
+### Locally running ClickHouse Server {#connect-to-clickhouse-local}
+If you're running ClickHouse locally on your machine and want to connect Rill to this, you can fill out the same form using `localhost`. If you haven't made any changes to the defaults, the user should be `default` with no password.
+
+
+
+
+If you've got any further questions, please refer to our documentation, [here](https://docs.rilldata.com/reference/olap-engines/clickhouse). (Note: you are leaving ClickHouse Docs!)
+
+## Create a Metrics View and Explore Dashboard {#create-explore-dashboard}
+Once you've successfully connected ClickHouse and Rill, you'll see all of the tables listed under your ClickHouse connector in the UI. You can browse the tables and create a metrics view/dashboard.
+
+
+
+
+### Via AI {#create-explore-dashboard-AI}
+
+Select the "..." from a table that you are intested and select `Generate Explore Dashboard with AI`. This will generate a `metrics/your_table_metrics.yaml`, and `dashboards/your_table_metrics_explore.yaml`. The dashboard created is our explore dashboard, which is our fast exploratory, slice-and-dice dashboard that Rill is known for. Just with a few clicks, you may find some insights into your data that you never though of before!
+
+
+
\ No newline at end of file
diff --git a/sidebars.js b/sidebars.js
index 58228e22fd7..0ce1e99e762 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -133,7 +133,7 @@ const sidebars = {
"use-cases/time-series/query-performance"
]
},
- {
+ {
type: "category",
label: "Data lake",
collapsed: true,
@@ -141,7 +141,7 @@ const sidebars = {
link: { type: "doc", id: "use-cases/data_lake/index" },
items: [
"use-cases/data_lake/glue_catalog",
- "use-cases/data_lake/unity_catalog"
+ "use-cases/data_lake/unity_catalog"
]
}
]
@@ -862,6 +862,7 @@ const sidebars = {
"integrations/data-visualization/omni-and-clickhouse",
"integrations/data-visualization/powerbi-and-clickhouse",
"integrations/data-visualization/quicksight-and-clickhouse",
+ "integrations/data-visualization/rill-and-clickhouse",
"integrations/data-visualization/rocketbi-and-clickhouse",
"integrations/data-visualization/superset-and-clickhouse",
{
@@ -1013,7 +1014,7 @@ const sidebars = {
"integrations/sql-clients/jupysql",
"integrations/sql-clients/qstudio",
"integrations/sql-clients/tablum",
- "integrations/sql-clients/marimo",
+ "integrations/sql-clients/marimo",
],
},
{
diff --git a/static/images/integrations/data-visualization/rill/rill_02.png b/static/images/integrations/data-visualization/rill/rill_02.png
new file mode 100644
index 0000000000000000000000000000000000000000..ae83278bc5826672ff3a534c8dfa2074200d872d
GIT binary patch
literal 63791
zcmeFZRa9Kd7Wa!2AV3JgEx3Dd>)`GloZ!KOTN5k^9^4yucefzH-5Lq*?tWMHIcM+v
zjr)3^zHxbB(4$zZs%BNqS^xQ){Y_a>3LTXY6$S
MXu SonLPwA`cR)
zHdi{28OA8??&cZo`q6#?E46za}%31pImybo_s5a6Yh-fScx27k|~
zQ%q4>teQCRqM+>6oOwja<#+^Hkx9uKmqs|=2>=aKcw8`a+hTOLdxe7*8(YFG+R;?}
z&XBcf8Hw67r4PI+c3W+ecEpAy8fnpk*CnJG1ki%8nV+RAl|l~BAM=K?%Q{*cPD0LY
z^wdL(zQK!)@QnmMVrS}%p!d7s<}?t^J$5)p%e)C@H<<`qn<|U8T^i}Xx!|pQCsk*8
zj9ufrjp{HWN4yg5!_RWOcyK&rnF0drVoEdx=FZQ6p@(rfyjecKG>&|BavW3DVZXc+
zWb|t11>bE41Dxp{?}Zc&j@;QD720$5d&v6Wj~@bdp$Q$4{04?@fz$b6+C$lL!ae7-
zDOOC=(O#9ik%ea(OEjOBZKe@xA>$h6<;Ynkcn`vPx-zu*{6FJPD@*h^GHuYK32yY3
zVGP|YrOhvkJTR=~CeBnOM!Hy?_jl
zOr?MlTS?hvHYFXc-O9xj3Lr`7@Fkd1g)rD9s-53lBOYMW2WN$MX-&0zxYbU|8L>11
z?9F2R$W>8M@#^?`bEiO#Q#6c99+z$lKZ`^ma~KXFy)6@1hfO6KQ|!Md
9;Yr_3&|wg<>S
zt&2oBS{rHT%iPD+JvtwSSe>r*CDXJHq`{CHn2wgoqdPq1{ju=3572&|YXR2oLFjw7
zTOa;wZEa7nvV7&Kmn*RrVg}j-mfm$5MSYGFvY0}~hoWv70b7)Xxm0UeASPsDt5v#k{~t4mDUEelhj
ziN3g3Ywv+>4$CKxTe+Qyj{Fn7Rc3LGRO@B0csw0?^^yxTY6E8?ZE%2OQY!mEI+#0M
zS+L;1WuXK0?%bDZRftos7sNj!Wf{Z|%YqSFb=IZC5A?EshhYZpTzODkBPwQVZ@_DD
zi!ARo+s?Y(k4&)Iy-($FZlS3~FMaa#;daqZHYSvmkT4zp6umols#zu*Ke1TQqA=K-
zDKt@<+X{fq)GjK|ls2MvvoSW25oZ^s>4zdV!zuA4hFxhlUL7ue^r!ma`^tZy(#Qiu
z0cP`ulFs2g{E*n