Skip to content

Part 2 of July Doc Revamp #7573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 27 commits into from
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
adding more content
Here's my thought, we dont have a great top to bottom joruney of rill in our docs

In each sub section, add the relevant templating and project defaults that are controlled by rill.yaml

Adding more content to guides such as the GA4 Demo, Cost monitoring Demo

I will also go through the contents of the docs and update where needed (did a brief pass and need to update our incrmental modeling pages)
  • Loading branch information
royendo committed Jul 5, 2025
commit 2bef3de42f0f66423aa32d8d1ba49c3df23ff5dd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ sidebar_position: 05
</div>
<br/>
----
While Rill's signature **[Explore dashboards](/build-dashboard/dashboards/dashboards.md)** let you slice, dice, and interact with your data in our suggested layout, **Canvas dashboards** let you define your own visualizations of data from multiple [metrics views](/define/metrics-view/metrics-view.md) and arrange them into your preferred layout.
While Rill's signature **[Explore dashboards](/build/dashboards/dashboards.md)** let you slice, dice, and interact with your data in our suggested layout, **Canvas dashboards** let you define your own visualizations of data from multiple [metrics views](/define/metrics-view/metrics-view.md) and arrange them into your preferred layout.

You can add the following widgets to a Canvas dashboard:

Expand Down
101 changes: 101 additions & 0 deletions docs/docs/build/rill-project-file.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
---
title: "Rill Project File"
description: For documenting required migrations
sidebar_label: "Dashbboard Project Defaults and Mock Users"
sidebar_position: 45
---


The Rill project file `rill.yaml` is often overlooked but is a powerful tool as it sets defaults, environmental variables, and connector settings. Let's walk through setting up [`mock_users`](/manage/security#in-rill-developer) to test row access policies, default security settings for your metrics views and explore dashboards, refresh schedules, MCP `ai_instructions`, and the default OLAP connector.

<img src = '/img/tutorials/admin/project.png' class='rounded-gif' />
<br />

## Explore Defaults
Similar to metrics views, you can set similar security to an explore dashboard. (Note that only `access` can be set on the dashboard level.)

You are also able to set the `defaults` parameter in the explores dashboard to define your default time range, as well as the available time_zones and time_ranges in an Explore dashboard.
```yaml
explores:
defaults:
time_range: P3M
time_zones:
- America/Denver
- UTC
time_ranges:
- PT24H
- P7D
- P14D
- P3M
```


:::tip Order of Operations
Rill YAML settings < Explore Dashboard YAML < Bookmarks in Rill Cloud < User Last State
:::





## Mock Users
Access to your environment is a crucial step in creating your project in Rill Developer. By doing so, you can confidently push your dashboard changes to Rill Cloud. This is done via the mock_users in the project file. You can create pseudo users with specific domains, or admin and non-admin users or user groups, to ensure that access is correct.

Let's assume that the following are applied to the metrics view.

```yaml
security:
access: "{{ .user.admin }} OR '{{ .user.domain }}' == 'example.com'"
row_filter: "domain = '{{ .user.domain }}'"
```

In order to test both the access to the dashboard, as well as the row filter, we can create the following in the project YAML.

```yaml
mock_users:
- email: royendo@rilldata.com
admin: true
- email: your_email@domain.com
groups:
- tutorial-admin
- email: your_email2@another_domain.com
```

### Embedded dashboard Mock Users
Embedded dashboards are another type of dashboards that you'll want to test in Rill Developer. Mainly because there is no way to pass the custom variables in Rill Cloud to ensure that access and data is being presented correctly. In order to do this, you'll need to add the following to your mock_users:
```yaml
- email: embed@rilldata.com
name: embed
custom_variable_1: Value_1 #this is passed at embed creation
custom_variable_2: Value_2 #this is passed at embed creation
```
See our [Custom Attributes Embedded dashboard](https://rill-embedding-example.netlify.app/rowaccesspolicy/custom) live!

Let's assume a similar set up to the above example. Within the metrics view, we define:

```yaml
security:
access: true
row_filter: >
app_site_name = '{{ .user.app_site_name }}' AND
pub_name = '{{ .user.pub_name }}'
```

Then within the application we are passing

```yaml
app_site_name='Sling'
pub_name='MobilityWare'
```

You can do a test mock user to ensure that this dashboard is working as designed with the following:

```yaml
- email: embed@rilldata.com
name: embed
app_site_name: 'Sling'
pub_name: 'MobilityWare'
```
<img src = '/img/tutorials/admin/custom-attribute-mock-user.png' class='rounded-gif' />
<br />

2 changes: 1 addition & 1 deletion docs/docs/concepts/OLAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Rill supports creating and powering dashboards using existing tables from altern

## Supported OLAP Engines

Rill currently supports the following OLAP engines. Please refer to our [Build Section](../ingest-sources/olap/olap.md) for more information on the topic.
Rill currently supports the following OLAP engines. Please refer to our [Build Section](../ingest/olap/olap.md) for more information on the topic.

- DuckDB
- ClickHouse
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/metrics-layer.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ A metrics layer is a `centralized framework` used to define and organize **key m
Starting from version 0.50, the operation of creating a dashboard via AI will create a metrics view and dashboard separately in their own respective folders and navigate you to a preview of your dashboard. If you find that some metrics need to be modified, you will need to navigate to your [metrics/model_name_metrics.yaml](/define/metrics-view/) file.


Assuming that you have the ' * ', select all, in your dashboard configurations, any changes will automatically be changed on your [explore dashboard](/build-dashboard/dashboards/).
Assuming that you have the ' * ', select all, in your dashboard configurations, any changes will automatically be changed on your [explore dashboard](/build/dashboards/).
:::


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Rill's modeling layer provides open-ended SQL compatibility for complex SQL quer

## Measure Expressions

Measure expressions can take any SQL numeric function, a set of aggregates, and apply filters to create derived metrics. A reminder on basic expressions is available in the [create metrics view definition](/build-dashboard/metrics-view#measures).
Measure expressions can take any SQL numeric function, a set of aggregates, and apply filters to create derived metrics. A reminder on basic expressions is available in the [create metrics view definition](/build/metrics-view#measures).

See our dedicated examples and pages for the following advanced measures!
- **[Metric Formatting](/define/metrics-view/advanced-expressions/metric-formatting)**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,26 +1,13 @@
---
title: "Rill Project File"
description: For documenting required migrations
sidebar_label: "Rill Project File"
sidebar_label: "Metrics View Project Defaults"
sidebar_position: 45
---


The Rill project file `rill.yaml` is often overlooked but is a powerful tool as it sets defaults, environmental variables, and connector settings. Let's walk through setting up [`mock_users`](/manage/security#in-rill-developer) to test row access policies, default security settings for your metrics views and explore dashboards, refresh schedules, MCP `ai_instructions`, and the default OLAP connector.

<img src = '/img/tutorials/admin/project.png' class='rounded-gif' />
<br />

## Project Refresh Schedule
Setup your project's model refresh schedule. You can override this in the model's YAML file if you need.
```yaml
models:
refresh:
cron: '0 * * * *'
```

## Default OLAP Connector
When adding an OLAP connector to your project, this will automatically populate with the new OLAP connector. IE: `ClickHouse`, `Druid`

## `ai_instructions`
With our new MCP feature, you may want to pass some project context to the Agent so that it can understand better what this project is used for. A classic example is that this project is a QA project and you dont want to include it in the analysis. In this case, you can add something like below.
Expand All @@ -29,7 +16,25 @@ With our new MCP feature, you may want to pass some project context to the Agent
ai_instructions: This project is a QA project, do not include this project in any of the MCP calls. If a user asks for this project specifically, always indicate in the answer's header and footer, "This project is a QA project and its number's are not verified. You should not be using this for any purposes other than QA."
```

## Mock Users
## Metrics Views Defaults
By default, Rill is open to access (to your organization users), unless otherwise defined. To add project-level access to the Rill project, you can add a default metrics view security policy in the rill.yaml file. Like a metrics_view, you can define the security as shown below. For more information, read our [dashboard access documentation](/manage/security#examples).

```
metrics_views:
security:
access:
row_fitler:
```

Other parameters that can be set in the defaults are `first_day_of_week` and `smallest_time_grain`.

:::tip Order of Operations

Rill YAML settings < Metrics View YAML
:::


## Testing Access to Data via Mock Users
Access to your environment is a crucial step in creating your project in Rill Developer. By doing so, you can confidently push your dashboard changes to Rill Cloud. This is done via the mock_users in the project file. You can create pseudo users with specific domains, or admin and non-admin users or user groups, to ensure that access is correct.

Let's assume that the following are applied to the metrics view.
Expand Down Expand Up @@ -92,44 +97,3 @@ You can do a test mock user to ensure that this dashboard is working as designed



## Metrics Views Defaults
By default, Rill is open to access (to your organization users), unless otherwise defined. To add project-level access to the Rill project, you can add a default metrics view security policy in the rill.yaml file. Like a metrics_view, you can define the security as shown below. For more information, read our [dashboard access documentation](/manage/security#examples).

```
metrics_views:
security:
access:
row_fitler:
```

Other parameters that can be set in the defaults are `first_day_of_week` and `smallest_time_grain`.

:::tip Order of Operations

Rill YAML settings < Metrics View YAML
:::

## Explore Defaults
Similar to metrics views, you can set similar security to an explore dashboard. (Note that only `access` can be set on the dashboard level.)

You are also able to set the `defaults` parameter in the explores dashboard to define your default time range, as well as the available time_zones and time_ranges in an Explore dashboard.
```yaml
explores:
defaults:
time_range: P3M
time_zones:
- America/Denver
- UTC
time_ranges:
- PT24H
- P7D
- P14D
- P3M
```


:::tip Order of Operations
Rill YAML settings < Explore Dashboard YAML < Bookmarks in Rill Cloud < User Last State
:::


4 changes: 2 additions & 2 deletions docs/docs/deploy/deploy-credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ sidebar_position: 10
When deploying a project, credentials that have been defined in your `.env` file will be automatically passed into your Rill Cloud project. However, for [remote sources](/reference/connectors/connectors.md) that are dynamically retrieving your credentials via the CLI, such as S3 and GCS, you will need to ensure that these are [defined in the .env file](/manage/project-management/variables-and-credentials#credentials-naming-schema).


[Local credentials](/ingest-sources/credentials/#setting-credentials-for-rill-developer) are used by Rill Developer to connect to sources from your local machine, while [deployment credentials](/deploy/deploy-credentials#configure-environmental-variables-and-credentials-for-rill-cloud) are what is used by Rill Cloud for production workloads. There are a [few ways to set up credentials in Rill Developer](../ingest-sources/credentials/#setting-credentials-for-rill-developer), however you will need to ensure that they are set up in your `.env` file for a seemless experience.
[Local credentials](/ingest/connect/credentials/#setting-credentials-for-rill-developer) are used by Rill Developer to connect to sources from your local machine, while [deployment credentials](/deploy/deploy-credentials#configure-environmental-variables-and-credentials-for-rill-cloud) are what is used by Rill Cloud for production workloads. There are a [few ways to set up credentials in Rill Developer](../ingest/connect/credentials/#setting-credentials-for-rill-developer), however you will need to ensure that they are set up in your `.env` file for a seemless experience.

:::info Separating development and production credentials

Expand Down Expand Up @@ -69,6 +69,6 @@ Using service accounts for production workflows and pipelines is a general best

:::warning Be careful of overriding local credentials and/or pushing the wrong credentials to Rill Cloud

When using service accounts, it is very likely that different or even personal credentials are being used in local development (i.e. Rill Developer). Therefore, it is worth double checking that the correct credentials are being used or set before [syncing credentials](../ingest-sources/credentials/credentials.md#pulling-credentials-and-variables-from-a-deployed-project-on-rill-cloud) between your local instance of [Rill Developer and Rill Cloud](../ingest-sources/connect/connect.md#rill-developer-vs-rill-cloud) using the `rill env push` and `rill env pull` commands respectively
When using service accounts, it is very likely that different or even personal credentials are being used in local development (i.e. Rill Developer). Therefore, it is worth double checking that the correct credentials are being used or set before [syncing credentials](/ingest/connect/credentials.md#pulling-credentials-and-variables-from-a-deployed-project-on-rill-cloud) between your local instance of [Rill Developer and Rill Cloud](../ingest/connect/connect.md#rill-developer-vs-rill-cloud) using the `rill env push` and `rill env pull` commands respectively

:::
2 changes: 1 addition & 1 deletion docs/docs/deploy/deploy-dashboard/deploy-dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebar_position: 00
Deploying dashboards from Rill Developer allows you to share dashboards with other users, leverage [Rill Cloud capabilities](../../explore/dashboard-101), [embed Rill](/integrate/embedding.md) into other applications, and more!

:::tip Configure credentials
Cloud datastores will typically require service keys to access data. Make sure to you create the necessary key for your service account and either add these credetials to your `.env` file directly or deploy your project and then run ```rill env configure``` with the correct credentials. For more details, please refer to our [connector documentation](/ingest-sources/credentials/credentials.md).
Cloud datastores will typically require service keys to access data. Make sure to you create the necessary key for your service account and either add these credetials to your `.env` file directly or deploy your project and then run ```rill env configure``` with the correct credentials. For more details, please refer to our [connector documentation](/ingest/connect/credentials.md).
:::

The flow diagram below shows two options for deploying an existing project.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/deploy/deploy-dashboard/github-101.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Once you have downloaded GitHub and connected your account, you'll be able to cr

- Run the Rill install command ```curl https://rill.sh | sh``` (or run ```rill start``` if you've already installed)

Now - any changes you make locally can be synced directly with your GitHub repo in one click! You can revisit our [build section](/ingest-sources/connect/connect.md) for refreshers on connecting to new sources, modeling data, or building dashboards.
Now - any changes you make locally can be synced directly with your GitHub repo in one click! You can revisit our [build section](/ingest/connect/connect.md) for refreshers on connecting to new sources, modeling data, or building dashboards.

## Pushing Changes

Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy