Skip to content

Commit

Permalink
small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
royendo committed Dec 3, 2024
1 parent dfa0b3c commit ce0f188
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 34 deletions.
39 changes: 19 additions & 20 deletions docs/docs/build/dashboards/customize.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,35 @@ For a full list of available dashboard properties and configurations, please see
:::


**`time_ranges`**
**`time_ranges:`**

One of the more important configurations, available time ranges allow you to change the defaults in the time dropdown for periods to select. Updating this list allows users to quickly change between the most common analyses like day over day, recent weeks, or period to date. The range must be a valid [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations) or one of the [Rill ISO 8601 extensions](../../reference/rill-iso-extensions.md#extensions).

```yaml
available_time_ranges:
- PT15M
- PT1H
- P7D
- P4W
- rill-TD ## Today
- rill-WTD ## Week-To-date
- PT15M
- PT1H
- P7D
- P4W
- rill-TD ## Today
- rill-WTD ## Week-To-date
```
**`time_zones`**
**`time_zones:`**

Rill will automatically select several time zones that should be pinned to the top of the time zone selector. It should be a list of [IANA time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). You can add or remove from this list for the relevant time zones for your team.

```yaml
- America/Los_Angeles
- America/Chicago
- America/New_York
- Europe/London
- Europe/Paris
- Asia/Jerusalem
- Europe/Moscow
- Asia/Kolkata
- Asia/Shanghai
- Asia/Tokyo
- Australia/Sydney
- America/Los_Angeles
- America/Chicago
- America/New_York
- Europe/London
- Europe/Paris
- Asia/Jerusalem
- Europe/Moscow
- Asia/Kolkata
- Asia/Shanghai
- Asia/Tokyo
- Australia/Sydney
```

### Setting Default Views for Dashboards
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/reference/project-files/explore-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@ In your Rill project directory, create a explore dashboard, `<dashboard_name>.ya
**`time_zones`** — Refers to the time zones that should be pinned to the top of the time zone selector. It should be a list of [IANA time zone identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). By adding one or more time zones will make the dashboard time zone aware and allow users to change current time zone within the dashboard _(optional)_.
**`theme`** — Refers to the default theme to apply to the dashboard. A valid theme must be defined in the project. Read this [page](./themes.md) for more detailed information about themes _(optional)_.
```yaml
theme:
colors:
primary: hsl(180, 100%, 50%)
secondary: lightgreen
```

**`security`** - Defines a [security policy](/manage/security) for the dashboard _(optional)_.
- **`access`** - Expression indicating if the user should be granted access to the dashboard. If not defined, it will resolve to `false` and the dashboard won't be accessible to anyone. Needs to be a valid SQL expression that evaluates to a boolean _(optional)_.
22 changes: 10 additions & 12 deletions docs/docs/tutorials/rill_clickhouse/2-r_ch_connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,17 +25,8 @@ Depending what you choose, the contents of your connection will change and I rec

:::

### Changing the default OLAP engine
Let's navigate to the rill.yaml file and add the following.

```yaml
compiler: rillv1

title: "Rill and ClickHouse Project"
olap_connector: clickhouse
```
Once updated, we can create the clickhouse connection by selection `+Add Data` > `ClickHouse` and fill in the components on the UI.
### Connect to ClickHouse
We can create the clickhouse connection by selection `+Add Data` > `ClickHouse` and fill in the components on the UI.

![clickhouse](/img/tutorials/ch/clickhouse-connector.png)
:::tip
Expand All @@ -47,7 +38,14 @@ You can obtain the credentials from your ClickHouse Cloud account by clicking th
```

:::
Once this is created, a `clickhouse.yaml` file will appear in the `connectors` folder.
Once this is created, a `clickhouse.yaml` file will appear in the `connectors` folder and the following will be added to your rill.yaml.

```yaml
compiler: rillv1

title: "Rill and ClickHouse Project"
olap_connector: clickhouse #automatically added
```
Example for a locally running ClickHouse server:
```yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/rill_clickhouse/4-r_ch_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ tags:

### Create the explore dashboard

When you're ready, you can create the visualization on top of the metric layer. Let's select `Create Explore dashboard`. This will create a simple explore-dashboards/uk_price_paid_metrics_explore.yaml file that reads in all the dimensions and measures. For more information on the available key-pairs, please refer to the [reference documentation.](https://docs.rilldata.com/reference/project-files/explores)
When you're ready, you can create the visualization on top of the metric layer. Let's select `Create Explore dashboard`. This will create a simple explore-dashboards/uk_price_paid_metrics_explore.yaml file that reads in all the dimensions and measures. For more information on the available key-pairs, please refer to the [reference documentation.](https://docs.rilldata.com/reference/project-files/explore-dashboards)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const sidebars = {
{
type: 'category',
label: 'Rill Developer to Rill Cloud in 6 steps!',
description: 'Rill Developer to to Rill Cloud',
description: 'Rill Developer to Rill Cloud',

items: [
'tutorials/rill_basics/launch',
Expand Down

0 comments on commit ce0f188

Please sign in to comment.