Skip to content
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

Fix tutorial env var name #6048

Closed
wants to merge 12 commits into from
12 changes: 12 additions & 0 deletions docs/docs/build/connect/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,18 @@ To add a remote source using the UI, click "+" by Sources in the left hand navig

After import, you can reimport your data whenever you want by clicking the "refresh source" button in the Rill UI.

:::note Have a firewall setup?
You need to whitelist the following IP addresses to connect to/from Rill Cloud and your service behind the firewall.
```
35.196.245.100
34.74.117.37
35.196.153.31
34.75.22.143
34.148.167.51
35.237.60.193
```
:::

### Using code
When you add a source using the UI or CLI, a code definition will automatically be created as a `.yaml` file in your Rill project in the `sources` directory.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/build/dashboards/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
position: 40
label: Create Dashboards
label: Create Explore Dashboards
collapsible: true
collapsed: true
32 changes: 26 additions & 6 deletions docs/docs/build/dashboards/dashboards.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Create Dashboards
title: Create Explore Dashboards
description: Create dashboards using source data and models with time, dimensions, and measures
sidebar_label: Create Dashboards
sidebar_label: Create Explore Dashboards
sidebar_position: 00
---

Expand All @@ -17,11 +17,31 @@ When including dimensions and measures only the named resources will be included
Rill also supports the ability to exclude a set of named dimensions and measures.

```yaml
metrics_view: my_metrics_view

dimensions: [country, region, product_category] # Only these three dimensions will be included
measures:
exclude: [profit] # All measures except profit will be included
type: explore

title: Title of your Explore Dashboard
description: a description for your explore dashboard
metrics_view: my_metricsview

dimensions: '*' #can use regex
measures: '*' #can use regex

theme: #your default theme

time_ranges: #was available_time_ranges, list the time of available time ranges that can be selected in your dashboard
time_zones: #was available_time_zones, list the time zones that are selectable in the dashboard

defaults: #define all the defaults within here, was default_* in previous dashboard YAML
dimensions:
measures:
time_range:
comparison_mode:
comparison_dimension:

security:
access: #only dashboard access can be defined here, other security policies must be set on the metrics view

```

:::tip
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/build/metrics-view/_category_.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
position: 38
label: Create Metrics Views
collapsible: true
collapsed: true
collapsed: true
13 changes: 11 additions & 2 deletions docs/docs/build/olap/olap.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,20 @@ Rill supports the use of several different OLAP engines to power your dashboards
- [Pinot](/reference/olap-engines/pinot.md)

:::note Additional OLAP Engines

Rill is continually evaluating additional OLAP engines that can be added. For a full list of OLAP engines that we support, you can refer to our [OLAP Engines](/reference/olap-engines) page. If you don't see an OLAP engine that you'd like to use, please don't hesitate to [reach out](contact.md)!

:::

## Externally Hosted Services
If you have a firewall in front of your externally hosted service, you will need to whitelist the below IP addresses. This will allow you to connect to/from your service once your project is deployed to Rill Cloud.
```
35.196.245.100
34.74.117.37
35.196.153.31
34.75.22.143
34.148.167.51
35.237.60.193
```


## DuckDB

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/concepts/operational.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Operational BI vs. Traditional BI
sidebar_label: What is Operational BI
sidebar_label: What is Operational BI?
sidebar_position: 10
hide_table_of_contents: true
---
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/deploy/deploy-dashboard/trial-accounts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Trials Deployments"
description: Deploying Trials in Rill Cloud
sidebar_label: "Trial Deployments"
sidebar_position: 30
---
3 changes: 2 additions & 1 deletion docs/docs/explore/bookmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Common use cases for Bookmarks include:

On the top right portion of the screen, you will see the Bookmark icon to bring up the option to save a bookmark. Clicking that icon brings up options to save the current page as your homescreen, create a new bookmark page, or to see your list of bookmarks (and shared bookmarks).

![bookmark](../../static/img/explore/bookmarks/bookmark.png)
<img src = '/img/tutorials/205/bookmark.gif' class='rounded-gif' />
<br />

On the bookmark screen, you'll then be able to set the options related to the saved view:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/explore/dashboard-101.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The main screen of any Rill dashboard is called the _Explore_ page. As seen abov

- _**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#administrator-shares-from-rill-cloud) or [externally](./public-url.md)) by clicking the `Share` button.
- _**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 by clicking the `Share` button](/manage/user-management#admin-invites-user-from-rill-cloud) or [externally via Public URLs](./public-url.md)) .


### Metrics Panel
Expand Down
78 changes: 64 additions & 14 deletions docs/docs/home/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,17 @@ rill uninstall
```




## Rill Developer

![dev](/img/concepts/rcvsrd/empty-project.png)

### What is Rill Developer?
Please review [our documentation](https://docs.rilldata.com/concepts/developerVsCloud#rill-developer).
Rill Developer is a local application used to preview your project and make any necessary changes before deploying to Rill Cloud. For more information, please review [our documentation](https://docs.rilldata.com/concepts/developerVsCloud#rill-developer).

### I'm having issues with Rill Developer...

Please refer to our tutorials to get started using Rill! (coming soon!)


import ComingSoon from '@site/src/components/ComingSoon';
Please refer to [our tutorials](/tutorials) to get started using Rill. If you still have any questions, please [contact us!](/contact)

<ComingSoon />

<div class='contents_to_overlay'>
a
</div>

### How do I start more than one instance of Rill Developer?

Expand All @@ -83,8 +75,11 @@ You need to [deploy your dashboard to Rill Cloud](https://docs.rilldata.com/depl

## Rill Cloud

![dev](/img/concepts/rcvsrd/Rill-Cloud.png)


### What is Rill Cloud?
Please review [our documentation](https://docs.rilldata.com/concepts/developerVsCloud#rill-cloud).
Rill Cloud is where your deployed Rill project exists and can be shared to your colleagues, or end-users. For more information, please review [our documentation](https://docs.rilldata.com/concepts/developerVsCloud#rill-cloud).

### How do I deploy to Rill Cloud?
You can deploy your project directly from the UI by selecting [the Deploy button](https://docs.rilldata.com/deploy/existing-project/#deploying-a-project-via-the-ui).
Expand All @@ -95,8 +90,63 @@ You can deploy your project directly from the UI by selecting [the Deploy button

### How do I make changes to my dashboard in Rill Cloud?

You can follow the same steps as above. The button will have changed from `deploy` to `update`. After selecting this, the objects in your Rill project will be updated.
You can follow the same steps as above. The button will have changed from `deploy` to `update`. After selecting this, the objects in your Rill project will be updated. Or, after syncing your Rill project to Github, simply push changes directly to the repository and this will automatically update your project on Rill Cloud.

### How do I share my dashboard to other users?

You will need to [invite users to your organization/project](https://docs.rilldata.com/manage/user-management#option-1---admin-invites-user) or send them a URL for them to [request access to your dashboard](https://docs.rilldata.com/manage/user-management#option-2---user-requests-access). If you just want them to see the contents of your dashboard, you can look into using [public URLs](https://docs.rilldata.com/explore/share-url).


## Rill Cloud Trial

### What is Rill Cloud Trial?

We now offer a self serve option for our users using Rill Cloud to get started. Before signing up for a [Teams plan](https://www.rilldata.com/pricing), you can create an account and start your free trial. Note that the banner will show you the remaining days for your trial and will update as the expiration gets closer!

![img](/img/FAQ/rill-trial-banner.png)

### When does my trial start?

Your trial will start when you deploy a project to Rill Cloud. An Organization will be autoamatically created during this process using your email.

### How long does my Rill Cloud Trial last?

Currently, a Rill Cloud Trial lasts for 30 days. If you have any comments or concerns, please reach out to us on our [various platforms](../contact.md)!

### What is included in the free trial?

The free trial is locked at 2 projects and up to 10GB of data each. You can invite as many users as required.

### What happens to my project if I do not pay on time?

Your projects will hibernate. Your project metadata will still be available once you've activated your team plan.

![expired](/img/FAQ/expired-project.png)

### What is project hibernation?

When a project is inactive for a specific number of days or your trial has expired, we automatically hibernate the project. What this means is that all of your information and metadata is saved and resource consumption will be zero. You will need to unhibernate the project to gain access to the dashboard again. If the project is hibernated due to payment issues, the project will stay in this state until payment is confirmed. Once the payment is confirmed, you can redeploy the project with the following:

```
rill project hibernate <project_id> --redeploy
```

## Rill Cloud Team Plan (Billing)

### How do I activate my Team Plan?

You can activate your Team Plan via the Billing page from the settings in Rill Cloud. If you have not already, you will be prompted to add a payment method via Stripe. Please note that the cost of your plan depends on how much data you will be ingesting into Rill. For more information on costs, please refer to our [pricing page](https://www.rilldata.com/pricing).

![billing](/img/FAQ/rill-org-billing.png)


### What does the Team Plan include?

The base Team Plan starts at $250/month with 10GB of data included. For data over 10GB, this is priced at $25/GB. For more information, please refer to our [pricing page](https://www.rilldata.com/pricing).


### How can I see my current data usage?

This is viewable via the Usage page in the Organization Settings page.

! [usage] ()
2 changes: 1 addition & 1 deletion docs/docs/home/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ rill start my-rill-project
boxShadow: "0px 4px 15px rgba(0, 0, 0, 0.2)" /* Shadow effect */
}}>
<iframe credentialless="true"
src="https://www.youtube.com/embed/GMsUyj_Bv3Q?autoplay=1&mute=1&rel=0&si=CMltjZI4S5oAAAtg"
src="https://www.youtube.com/embed/7TlO6E5gZzY?autoplay=1&mute=1&rel=0&si=CMltjZI4S5oAAAtg"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen
Expand Down
74 changes: 66 additions & 8 deletions docs/docs/manage/project-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,28 @@ sidebar_label: "Organizations and Projects"
sidebar_position: 19
---

Once a project is ready to be deployed onto Rill Cloud, as an admin, you will need to manage your organization, project, and user access. Depending on where you set this access, the permissions can vary. Please see our [Roles and Permission](roles-permissions.md) page for more details.
Once a project is ready to be deployed onto Rill Cloud, as an administrator, you will need to manage your organization, project, and user access. Depending on where you set this access, the permissions can vary. Please see our [Roles and Permission](roles-permissions.md) page for more details.

## Organization

![img](/img/manage/project-management/org-view.png)
:::tip Deploying for the first time?
If it is your first time deploying, we will automatically generate an organization for you! To make changes to the name of the organization, navigate to the Settings page.
:::

![img](/img/manage/project-management/rill-org.png)

An Organization in Rill is the parent management object and encompasses how your team or organization interfaces with Rill Cloud. Organizations are designed to hold the differnet components of your Rill project. Organizations consists of projects that each consist of their own source, models, metrics view, dashboards and more.

### Managing an Organization via Rill Cloud

Once your project has been deployed to Rill Cloud, you will be able to access the Organization's settings page.
From this page, you can manage users, modify your Billing (if on a `Team Plan`), and see your overall usage.


![img](/img/manage/project-management/rill-org-settings.png)


### Managing an Organization from the CLI
If you'd like to create, edit, modify, or delete an organization from the CLI, run the following command.

```
Expand Down Expand Up @@ -49,32 +63,76 @@ Access to Rill can be granted on the [organization level](/manage/user-managemen

A project is a single deployed instance from Rill Developer (or what we refer to as a Rill project). Each project can be connected to one GitHub repository. Once you have deployed a project to Rill Cloud, you can make changes to it via the CLI or via Rill Cloud.

## Rill Cloud

### Checking deployment status
After deploying to Rill Cloud, you will be navigating to the status page. Here you will be able to see your component's status and if there are any issues with loading or parsing.
After deploying to Rill Cloud, if your projects are not quite ready to view yet, you will be navigating to the status page. Here you will be able to see your component's status and if there are any issues with loading or parsing.

![img](/img/manage/project-management/status.png)

### Managing Project settings
You can also manage project objects in the settings page. Currently only Public URLS can be modified from the UI but more features coming soon!

![img](/img/explore/publicurl/public-url-settings.png)

### Deploying from a branch other than `main`
If you have already setup your connection to GitHub, you can edit the branch from where the project is deployed from.
If you have already [setup your connection to GitHub](/deploy/deploy-dashboard/#syncing-your-github-repository), you can edit the branch from where the project is deployed from.

![img](/img/manage/project-management/main-branch.png)


## CLI
## Managing Rill project from CLI
Managing a project includes the project itself and all components or resources that belong to the project. Via the CLI, you can make changes to the project's properties such as description, GitHub branch, etc using the following:


```
rill project
rill project
Manage projects

Usage:
rill project [command]

Available Commands:
list List all the projects
show Show project details
edit Edit the project details
rename Rename project
hibernate Hibernate project
delete Delete the project
status Project deployment status
splits List splits for a model
logs Show project logs
describe Retrieve detailed state for a resource
refresh Refresh one or more resources
connect-github Deploy project to Rill Cloud by pulling project files from a git repository
deploy Deploy project to Rill Cloud by uploading the project files

Flags:
--org string Organization Name (default "your_org")

Global Flags:
--api-token string Token for authenticating with the cloud API
--format string Output format (options: "human", "json", "csv") (default "human")
-h, --help Print usage
--interactive Prompt for missing required parameters (default true)

Use "rill project [command] --help" for more information about a command.
```

:::note
There are still some actions within Rill that require CLI commands:
- refreshing source on Rill Cloud
- delete / hibernate project
- reading Rill Cloud logs
- renaming projects,
- etc.
:::

### Refreshing the deployment

Your project on Rill Cloud will automatically redeploy every time you git push changes to Github. To manually refresh data sources without pushing code changes (or redeploying your project), run the following command:

```
rill project refresh
rill project refresh [--source/model] (source_name or model_name) [--local]
```


Expand Down
Loading