Skip to content

Commit

Permalink
Sections of Explore rewritten (#5586)
Browse files Browse the repository at this point in the history
* reorg Explore

* Explore Section Updated

* Update 0.48.md
  • Loading branch information
royendo authored Sep 3, 2024
1 parent 5dfc44a commit 27f01ef
Show file tree
Hide file tree
Showing 11 changed files with 57 additions and 24 deletions.
2 changes: 1 addition & 1 deletion docs/blog/0.48.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ With just a click of a button you can now easily go from looking at metrics over
- Fixed Developer's mock user dropdown display issue.
- Fixed allignment issue in the UI.
- Fixed issue with orphaned reports and alerts continuing to send.
- Fixed issue where dimension values were automatically formatted where not desired.
- Fixed issue where dimension values were automatically formatted where not desired.
37 changes: 27 additions & 10 deletions docs/docs/explore/dashboard-101.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,42 @@ sidebar_position: 00

## Overview

Depending on whether you are opening Rill Developer or logging into Rill Cloud, you will either the default "Getting started" landing page or a list of all projects available to your user. For the purposes of this article, we will assume that your project has already been [deployed to Rill Cloud](../deploy/existing-project/existing-project.md) and that you are looking to consume your dashboards in a production capacity.
Depending on whether you are opening Rill Developer or logging into Rill Cloud, you will either the default "Getting started" landing page or a list of all projects available to your user. For the purposes of this article, we will assume that your project has already been [deployed to Rill Cloud](../deploy/existing-project/existing-project.md) and that you are looking to consume your dashboards in a production capacity. For more information on the differences, refer to [Rill Cloud vs Rill Developer](../concepts/developerVsCloud.md)

After logging into [Rill Cloud](https://ui.rilldata.com), you should see all projects within your [organization](../manage/project-management#organization) that is available and/or has been granted permissions to your user profile. Within each project, you'll then be able to access the corresponding individual dashboards that belong to a particular Rill project.

![Rill Cloud landing page](../../static/img/explore/dashboard101/rill-cloud-landing-page.png)

This quickstart will call out the basic navigation and default key features that are available within each dashboard. The rest of the **Explore** section will cover some of the more advanced capabilities that are possible with using dashboards on Rill Cloud.

## Getting Started
## Navigating the Dashboard

![quickstart](../../static/img/explore/dashboard101/quickstart.png)

The main screen of any Rill dashboard (referred to as _Explore_) is laid out with all metrics available in the underlying model on the left-hand side, broken out with summary numbers (e.g. BigNum) and timeseries visualizations (based on your configured `timeseries` column in your [dashboard YAML](/reference/project-files/dashboards.md)), and all dimensions available in the underlying model on the right-hand side via leaderboard / toplist charts. You can add or remove any metric and dimension from the page by simply selecting them from the dropdown above the charts (see `#1`). You can also drill into leaderboards further (see `#2`) to see all corresponding metrics for a specific dimension. Within that drilldown, you can also then sort by metric, search your dimensions, and/or [export data](exports.md).
**Explore**
The main screen of any Rill dashboard is called the _Explore_ page. As seen above, this is divided into three section.

In terms of navigating around your dashboard, starting at the very top, you can change the period of analysis to different ranges of time (see `#3`), either by selecting from a pre-defined period (such as last week) or choosing a custom date range. Then, next to the time selector, you can set comparisons to analyze the prior period and/or to compare dimensions. Underneath the time selector, you'll also be able to find your filter bar (see `#4`) where you can [add filters](filters/filters.md) for metrics (e.g. all campaigns with more than 1000 impressions) or for dimensions (e.g. `campaign_name = Instacart`). Furthermore, if you prefer a more interactive exploration experience, you can directly filter the data in your dashboard by clicking any row in one of the right-side leaderboard charts, including drilling down to a specific leaderboard (where you can then toggle between include/exclude as filter options).
- Navigation Bar
- Metrics panel
- Dimensions leaderboard

### Navigation Bar

- _**Time Selector and Time Selector Comparison:**_ You can change the period of analysis to different ranges of time (see `red` box), either by selecting from a pre-defined period (such as last week) or choosing a custom date range. Along with this, you can enable a comparison filter to compare range of dates with 1 click.

- _**Filtering:**_ Underneath the time selector, you'll also be able to find your filter bar (see `orange` box) where you can [add filters](filters/filters.md) for metrics (e.g. `campaigns>1000`) or for dimensions (e.g. `campaign_name = Instacart`).

- _**Explore or Pivot:**_ You can switch the view from _explore_ to [_pivot_](https://docs.rilldata.com/explore/filters/pivot) by selecting either from the UI (see `pink` box)

- _**Alerts, Bookmarks and Sharing:**_ You can create an [alert](./alerts/alerts.md) by selecting the bell, customizing the default view of the dashboard (see `purple` box) to a predefined set of metrics, dimensions, and filters by selecting the [bookmark](bookmarks.md), or share the dashboard ([internally](../manage/user-management.md#option-1---admin-invites-user) or [externally](./public-url.md)) by clicking the `Share` button.


### Metrics Panel

- _**Measures:**_ All _**metrics**_ that are available in the underlying model \ are viewable on the left-hand side, broken out with summary numbers (e.g. eCPM) and timeseries visualizations (based on your configured `timeseries` column in your [dashboard YAML](/reference/project-files/dashboards.md)). You can add or remove any metric from the page by simply selecting them from the dropdown above the charts (see `yellow` box). If you select any specific measure, you will be navigating to the [Time Dimension Detail](https://docs.rilldata.com/explore/filters/tdd).

### Dimensions Leaderboard Panel

- _**Dimensions:**_ All _**dimensions**_ available in the underlying model on the right-hand side via leaderboard / toplist charts. You can add or remove any dimension from the page by simply selecting them from the dropdown above the charts (see `green` boxes). You can also drill into leaderboards further (see `blue` box) to see all corresponding metrics for a specific dimension. Within that drilldown, you can also then sort by metric, search your dimensions, and/or [export data](exports.md).
:::info Search for individual attributes

After drilling into a leaderboard (or what we sometimes refer to as a _toplist_ chart), rather than scrolling and finding an individual attribute (especially if the list is very long), you can also quickly search for a value and select / apply it to your dashboard by using the upper-right search box.
Expand All @@ -32,15 +52,12 @@ After drilling into a leaderboard (or what we sometimes refer to as a _toplist_

:::

Finally, you can also customize the default view of your dashboard (see `#5` above) to a predefined set of metrics, dimensions, and filters using our saved view functionality - otherwise known in Rill as [bookmarks](bookmarks.md). Bookmarks allow you as an end user to quickly save and return to your mostly commonly used dashboard applied states - keeping one overall dashboard that's shared with others but saving your most common analyses as needed. You can also share a dashboard with others by clicking on the `Share` button to send a direct link to any analysis.

:::tip Don't have a Rill project or dashboard deployed yet?

:::tip Don't have a Rill project or dashboard deployed yet?
If you want to get hands on and see what interacting with a Rill dashboard feels like, we have a set of [demo projects](https://ui.rilldata.com/demo) already deployed on Rill Cloud and publicly available for everyone to try out. These [same projects](../home/get-started#example-projects) are also available on Github and can be deployed locally using Rill Developer.

:::

This is just the beginning and a quick basic 101 overview of interacting with any Rill dashboard!

For more details about additional capabilities and/or how to utilize more advanced functionality within Rill dashboards, please see the [reference](#reference) section.

Expand All @@ -49,5 +66,5 @@ For more details about additional capabilities and/or how to utilize more advanc
- [Filters & Comparisons](filters/filters.md)
- [Bookmarks & Sharing](bookmarks.md)
- [Exports & Scheduled Reports](exports.md)
- [Public URL](share-url.md)
- [Public URL](public-url.md)
- [Alerts](/explore/alerts/alerts.md)
24 changes: 13 additions & 11 deletions docs/docs/explore/filters/filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,12 @@ Users can add or hide dimensions and metrics to a subset of fields they wish to

:::tip hiding metrics and dimensions by default
You can also change settings in the dashboard configuration to hide certain fields by default. You may want to do this to make dashboards easier to use (less complicated, narrowed to most commonly used) and to improve performance (hide high cardinality dimensions or complicated expressions in metrics). For more details, check out [dashboard customizations](/build/dashboards/customize.md#setting-default-views-for-dashboards).

Or, an administrator can set the default view of a dashboard by [bookmarking the view](../bookmarks.md) as Home.
:::
## Dimension & Measure Filters

## Filter by Dimensions
### Filter by Dimensions

The primary/easiest way to filter data is by selecting values in the dimension tables. Leaderboards within Rill are fully interactive. Selecting any dimension in the table will automatically filter the remaining leaderboards and metrics by that selection.

Expand All @@ -31,7 +34,7 @@ Any filter applied in the Leaderboard will also show up in the filter bar at nex

![dimension-filter](../../../static/img/explore/filters/filter.gif)

## Filter by Metrics
### Filter by Metrics

There are also use cases where you want to filter by the metric values returned. As an example - all customers over $1000 in revenue, all campaigns with at least 1 million impressions, all delivery locations with late times over 4%, etc.

Expand All @@ -54,16 +57,18 @@ As an example - to see most active enterprise customers - filter all customers w

## Time & Dimension Comparisons

![img](/img/explore/filters/time-series.png)

### Time Comparisons
Time comparison is a key feature of Rill and recommended to find insights quicker by highlighting differences between periods. To compare different periods, first select your time period for analysis - either a predefined period or a custom range in top left time picker.
Time comparison is a key feature of Rill and recommended to find insights quicker by highlighting differences between periods. To compare different periods, first select your time period for analysis - either a predefined period or a custom range in top left time picker. After selecting that range, select the toggle to enable Time Comparisons.

After selecting that range, select Compare by Time - either defaulting to the same prior period or selecting a custom comparison period.

<img src = '/img/explore/alerts/time-series.gif' class='rounded-gif' />
<br />
:::note
Default and comparison periods can be configured in your dashboard file. Visit [Dashboard Reference](/reference/project-files/dashboards) for more details
:::

![time-picker](../../../static/img/explore/filters/image-3.png)

:::tip
Rill provides different options for time period comparison - by time period or by selected hours.
Expand All @@ -74,15 +79,12 @@ For the latter, you can compare the full period looking with options like last 2
:::

### Dimension Comparisons
In addition to time comparisons, you can select multiple dimension values to compare trends of those specific data points. There are two options for turning on dimension comparison:

- Use the same top filter bar as the time comparison, instead selecting a dimension for comparison
- Select the comparison option on the top left of any leaderboard and select multiple dimensions
In addition to time comparisons, you can select multiple dimension values to compare trends of those specific data points. Select the comparison option on the top left of any leaderboard and select multiple dimensions

De-select the comparison option or clear the filter bar to remove your comparisons.

![comparisons](../../../static/img/explore/filters/comparison.gif)

<img src = '/img/explore/filters/comparison.gif' class='rounded-gif' />
<br />
:::note
For more advanced time and dimension comparisons, visit the [Time Dimension Detail](tdd.md) page.
:::
3 changes: 2 additions & 1 deletion docs/docs/explore/filters/tdd.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Underneath the expanded time series chart, you will see two sets of dropdowns -
Similar to the filters, the Search and Exclude options from the expanded Leadersboards are available on the top right of the TDD table. Lastly, you can also take the TDD table directly to the Pivot view for multi-dimensional analysis - more details on [Pivot here](pivot.md).


![tdd](../../../static/img/explore/tdd/tdd.gif)
<img src = '/img/explore/tdd/tdd.gif' class='rounded-gif' />
<br />

:::tip Adjusting Time Grains
The TDD screen will carry time dimension from your previous filters which many be more granular than needed (diplay too many columns). Change the ```Metric Trends by``` filter on the type right to switch to alernate ranges like days, weeks, etc.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ In fact, users who click on a public shareable URL cannot see the parent filters
### How to manage public URLs via the CLI
:::tip

Starting from v.0.48, `share-url` has been rebranded to `public-url`.
Starting from v.0.48, `public-url` has been rebranded to `public-url`.

:::
```
Expand Down Expand Up @@ -81,3 +81,16 @@ rill public-url delete <id>
```

If you are interested in creating a public URL directly from the CLI, you can do so by passing the required parameters. (You can use the --help flag to see what additional flags are required.)


## Manage public URLs in Rill Cloud

import ComingSoon from '@site/src/components/ComingSoon';


<ComingSoon />

<div class='contents_to_overlay'>
Historically (pre 0.48), user management was only possible via the CLI. Now, it is also possible to do so via the UI!

</div>
Binary file added docs/static/img/explore/alerts/time-series.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/explore/dashboard101/quickstart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/explore/filters/comparison.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/static/img/explore/filters/time-series.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/explore/tdd/tdd.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 27f01ef

Please sign in to comment.