revised docs (#5304)

* revised docs added connector to dashboard and revised the hint in connectors * DuckDB Changes around DuckDB as a source, should not be used as a connector. Omitting areas where we mentioned using duckdb connector https://rilldata.slack.com/archives/CTCJ58H3M/p1721240453716359?thread_ts=1721120163.646589&cid=CTCJ58H3M * Update dashboards.md fixed typo
rilldata · Jul 19, 2024 · 499d17a · 499d17a
1 parent beceb4e
commit 499d17a
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 6 deletions.
diff --git a/docs/docs/reference/connectors/motherduck.md b/docs/docs/reference/connectors/motherduck.md
@@ -15,9 +15,9 @@ sidebar_position: 7
 
 ![Connecting to DuckDB/MotherDuck](/img/reference/connectors/motherduck/motherduck.png)
 
-## Connecting to DuckDB
+## Connecting to External DuckDB as a Source
 
-As noted above, if you wish to connect to a persistent DuckDB database to read existing tables, Rill will first need to be able to access the underlying DuckDB database. As DuckDB is an _in-memory_ database that's primarily used for local use cases, credentials are not required (and you will typically use Rill Developer). However, if the database file is <u>included</u> in your Git repository, then Rill Cloud will also be able to serve your DuckDB sourced dashboards.
+As noted above, if you wish to connect to a persistent DuckDB database to read existing tables, Rill will first need to be able to access the underlying DuckDB database. Once access has been established, the data will be read from your external databases into the built-in DuckDB database in Rill.
 
 ### Local credentials
 

diff --git a/docs/docs/reference/olap-engines/duckdb.md b/docs/docs/reference/olap-engines/duckdb.md
@@ -26,5 +26,4 @@ Well now you can! For more details, see our page on [Using Multiple OLAP Engines
 ## Additional Notes
 
 - For dashboards powered by DuckDB, [measure definitions](/build/dashboards/dashboards.md#measures) are required to follow standard [DuckDB SQL](https://duckdb.org/docs/sql/introduction) syntax.
-- Known issue around creating a DuckDB via the UI, you will need to create the YAML file manually.
-- Note that local running instances of DuckDB (outside of the default one) is mainly for development and local use. When uploading to Rill Cloud, it is recommended to use a `source` type instead
+- Known issue around creating a DuckDB source via the UI, you will need to create the YAML file manually.
diff --git a/docs/docs/reference/project-files/connectors.md b/docs/docs/reference/project-files/connectors.md
@@ -21,14 +21,13 @@ Select + Add -> Data -> Connect an OLAP engine
 **`type`** - refers to the resource type and must be 'connector'
 
 **`driver`** - refers to the [OLAP engine](../olap-engines/multiple-olap.md)
-- _`duckdb`_   link to [ DuckDB Documentation](https://duckdb.org/docs/guides/overview.html)
 - _`clickhouse`_ link to[ Clickhouse documentation](https://clickhouse.com/docs/en/intro)
 - _`druid`_ link to[ Druid documentation](https://druid.apache.org/docs/latest/design/)
 - _`pinot`_ link to[ Pinot documentation](https://docs.pinot.apache.org/)
 
 :::tip A note on OLAP engines
 
-You can have multiple OLAP engines in a single project and have each dashboard run on a different engine using the `connector` parameter directly on a dashboard.
+By defining the `connector` parameter in a [dashboard's YAML](dashboards.md) file, you can have multiple OLAP engines in a single project.
 
 :::
 

diff --git a/docs/docs/reference/project-files/dashboards.md b/docs/docs/reference/project-files/dashboards.md
@@ -25,6 +25,8 @@ Files that are *nested at any level* under your native `dashboards` directory wi
 
 **`timeseries`** — Refers to the timestamp column from your model that will underlie x-axis data in the line charts. If not specified, the line charts will not appear _(optional)_.
 
+**`connector`** — Refers to the OLAP engine, if using [multiple OLAP engines](../olap-engines/multiple-olap.md).
+
 **`default_time_range`** — Refers to the default time range shown when a user initially loads the dashboard. The value must be either a valid [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) (for example, `PT12H` for 12 hours, `P1M` for 1 month, or `P26W` for 26 weeks) or one of the [Rill ISO 8601 extensions](../rill-iso-extensions.md#extensions) (default). If not specified, defaults to the full time range of the `timeseries` column _(optional)_.
 
 **`smallest_time_grain`** — Refers to the smallest time granularity the user is allowed to view in the dashboard. The valid values are: `millisecond`, `second`, `minute`, `hour`, `day`, `week`, `month`, `quarter`, `year` _(optional)_.