Skip to content

Commit

Permalink
docs/ welcome to Rill (#5706)
Browse files Browse the repository at this point in the history
* Docs Re org,

Welcome to Rill,
Home/*

* Adding Trial info

* small changes

* Adding project hibernation to FAQ

* Update FAQ.md

* Added 60 second video to QuickStart

* make it pretty

* No suggest content on YT link

* fixed broken links

* Removed Trial information

Indeed, I agree with @AndrewRTsao and will go ahead and remove the trial section for now!

I think its worth to have at least the updated pages pushed to main and then we can add the trial information when ready. I will remove the contents with @ericokuma when im State-side to ensure that we're capturing all the correct information.

* Update get-started.md

* re-add make it pretty
  • Loading branch information
royendo authored Sep 19, 2024
1 parent 9ed280e commit 11838e6
Show file tree
Hide file tree
Showing 75 changed files with 201 additions and 123 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ rill start my-rill-project
<span> · </span>
<a href="https://docs.rilldata.com/home/install">Install</a>
<span> · </span>
<a href="https://docs.rilldata.com/home/get-started#example-projects-repository">Example Projects</a>
<a href="https://docs.rilldata.com/home/get-started#example-projects">Example Projects</a>
<span> · </span>
<a href="https://discord.gg/DJ5qcsxE2m">Community</a>
</h3>
Expand Down
8 changes: 8 additions & 0 deletions docs/docs/concepts/developerVsCloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,14 @@ Once the dashboard has been [deployed to Rill Cloud](../deploy/deploy-dashboard/


<img src = '/img/concepts/rcvsrd/Rill-cloud.png' class='rounded-gif' />
<details>
<summary> What are some things you can do in Rill Cloud?</summary>

Anything from source ingestion to modeling to creating dashboards.
| Alerts: <img src = '/img/concepts/rcvsrd/alert.gif' class='rounded-gif' /> | Bookmarks: <img src = '/img/concepts/rcvsrd/bookmark.gif' class='rounded-gif' /> |
|:---:|:---:|
| **Public url:** <img src = '/img/concepts/rcvsrd/public-url.gif' class='rounded-gif' /> | **Scheduled Report:** <img src = '/img/concepts/rcvsrd/scheduled-report.gif' class='rounded-gif' /> |
</details>

## Is Rill Cloud a higher offering than Rill Developer?

Expand Down
1 change: 1 addition & 0 deletions docs/docs/explore/dashboard-101.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ After drilling into a leaderboard (or what we sometimes refer to as a _toplist_




:::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.
:::
Expand Down
31 changes: 0 additions & 31 deletions docs/docs/home/.tutorial.md

This file was deleted.

102 changes: 102 additions & 0 deletions docs/docs/home/FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
title: FAQ
sidebar_label: FAQ
sidebar_position: 20
---

## Getting Started

### What is Rill?
Rill is an operational BI tool that provides fast dashboards that your team will actually use. Rill’s unique architecture combines a last-mile ETL service, an in-memory database, and operational dashboards - all in a single solution

## Install Rill

### How do I install Rill?
You can install rill using our installation script:
```bash
curl https://rill.sh | sh
```
### How do I upgrade Rill to the latest version?
If you installed Rill using the installation script described above, you can upgrade by running:
```
rill upgrade
```


### Rill cannot be opened because it is from an unidentified developer.
This occurs when Rill binary is downloaded via the browser. You need to change the permissions to make it executable and remove it from Apple Developer identification quarantine.
Below CLI commands will help you to do that:
```bash
chmod a+x rill
xattr -d com.apple.quarantine ./rill
```


### Error - This macOS version is not supported. Please upgrade.
Rill uses duckDB internally which requires a newer [macOS version](https:/duckdb/duckdb/issues/3824).
Please upgrade your macOS version to 10.14 or higher.


### How do I uninstall Rill?

You can uninstall Rill using the following command:
```bash
rill uninstall
```




## Rill Developer

### What is Rill Developer?
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';

<ComingSoon />

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

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

If you try to start two instances of Rill Developer, you will hit the following error:
```bash
Error: serve: server crashed: grpc port 49009 is in use by another process. Either kill that process or pass `--port-grpc PORT` to run Rill on another port
```

In other to run two instances, please use the following flags with a unique port number.
```bash
rill start --port 10010 --port-grpc 10011
```

### How do I share my dashboard with my colleagues?

You need to [deploy your dashboard to Rill Cloud](https://docs.rilldata.com/deploy/existing-project/) to share your dashboard.

## Rill Cloud

### What is Rill Cloud?
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).

<img src = '/img/deploy/existing-project/deploy-ui.gif' class='rounded-gif' />
<br />


### 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.

### 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).
87 changes: 30 additions & 57 deletions docs/docs/home/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,71 +3,44 @@ title: Quickstart & Examples
sidebar_label: Quickstart & Examples
sidebar_position: 10
---
import Video from '@site/src/components/Video';

<!-- WARNING: There are links to this page in source code. If you move it, find and replace the links and consider adding a redirect in docusaurus.config.js. -->

Rill's BI-as-code approach allows you to build and manage dashboards in a codeful way locally + integrate your analytics into other Git processes.
This tutorial is a step by step guide that will help you install Rill, ingest sources, model data and deploy a dashboard online.
## Quickstart

:::tip Example projects
If you're looking for a place to get started, check out one of our [example projects](#installing-examples) which cover a variety of sources and use cases.
:::


## Install Rill

Install `rill` on Mac or Linux ([WSL](https://learn.microsoft.com/en-us/windows/wsl/install) for Windows users) using the installation script:

```
curl https://rill.sh | sh
```

:::tip sharing dashboards in Rill cloud? clone your git repo first
If you plan to share your dashboards, it is helpful to start by creating a repo in Git. Go to https:/new to create a new repo. Then, run the [Rill install script](/home/install) in your cloned location locally to make deployment easier.

More details on deploying Rill via Git in our [Deploy section](../deploy/deploy-dashboard/).
:::

## Create your project

Start a new Rill project:
Run the following from the CLI to start Rill. Select a project from the UI or add your own data.

```
rill start my-rill-project
```

The Rill web app runs locally at `http://localhost:9009` and will create code files in the `my-rill-project` directory.

:::note
Starting from v0.48, we've made changes to the CORS policy to only allow calls from the default HTTP URL by default for security purposes. If you are hosting Rill Developer on a non-localhost endpoint **(not officially supported)**, this means that they will need to pass in the appropriate CORS origins / hostname via the --allowed-origins flag when starting Rill. Please refer to the [rill start reference page](https://docs.rilldata.com/reference/cli/start) for more details on using the `--allowed-origins` flag.
:::


## Load and transform data

On the welcome screen, initialize an example project or load up Rill with your own data (use local files, cloud storage and/or database connections)

Use the app to transform your data (data models) and quickly generate visualizations (dashboards).

## Deploy your dashboard

Once complete, you can deploy any Rill project with a dashboard to an authenticated hosted endpoint:

1. Create a new Github repository on [https:/new](https:/new) and push your `my-rill-project` directory to it
2. Setup continuous deployment from Github to Rill Cloud:
```
cd my-rill-project
rill project upload
```

## Share your dashboard

Projects on Rill Cloud are private by default. To invite others to explore your project, run:
```
rill user add
```

## Example Projects
---
<div style={{
position: "relative",
width: "100%",
paddingTop: "56.25%",
borderRadius: "15px", /* Softer corners */
boxShadow: "0px 4px 15px rgba(0, 0, 0, 0.2)" /* Shadow effect */
}}>
<iframe
src="https://www.youtube.com/embed/GMsUyj_Bv3Q?autoplay=1&mute=1&rel=0&si=CMltjZI4S5oAAAtg"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowFullScreen
style={{
position: "absolute",
top: 0,
left: 0,
width: "100%",
height: "100%",
borderRadius: "10px", // Apply to iframe as well for rounded effect
}}
></iframe>
</div>

## Example Projects Repository

We have created several example projects that highlight common use cases for Rill.

Expand All @@ -86,7 +59,7 @@ Current projects include:
- [GitHub Analytics](https:/rilldata/rill-examples/tree/main/rill-github-analytics): analyze GitHub activity to understand what parts of your codebase are most active, analyze contributor productivity, and evaluate the intersections between commits and files
- [Programmatic Ads/OpenRTB](https:/rilldata/rill-examples/tree/main/rill-openrtb-prog-ads): bidstream data for programmtic advertisers to optimize pricing strategies, look for inventory opportunities, and improve campaign performance
- [311 Operations](https:/rilldata/rill-examples/tree/main/rill-311-ops): a live datastream of 311 call centers from various locations in the US for example operational analytics

- [Final Tutorial Project](https:/rilldata/rill-examples/tree/main/my-rill-tutorial): A finalized version of the tutorial project with many working examples, a good place to reference any newer features, updated regularly.

## Installing Examples

Expand Down
50 changes: 42 additions & 8 deletions docs/docs/home/home.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,56 @@
---
title: Welcome to Rill
title: Let's get started!
slug: /
sidebar_label: Welcome to Rill
sidebar_position: 00
hide_table_of_contents: true
---
Dashboards that move as fast as your business. Build fast operational dashboards that your team will actually use.
Use the following to download Rill and start your first project, my-rill-project.

Unlike most BI tools, Rill comes with its own embedded in-memory database. Data and compute are co-located, and queries return in milliseconds. So you can pivot, slice, and drill-down into your data instantly.

Download Rill to start modeling data and create fast, exploratory dashboards.

```
```bash
curl https://rill.sh | sh
rill start my-rill-project
```

![home-demo](https://storage.googleapis.com/prod-cdn.rilldata.com/docs/rill_hero.gif)
<img src = 'https://storage.googleapis.com/prod-cdn.rilldata.com/docs/rill_hero.gif' class='rounded-gif' />
<br />

## Tutorials

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

<ComingSoon />

<div class='contents_to_overlay'>


If you're looking for a in-depth tutorial that walks you through our software and results in a finished project with all of our available features, head over to our [tutorials] to get started.

Some of the Tutorials include:

- [From Source to Deployment in 5 steps!] : Data Import, Transformation, Dashboard, to Deployment!
- [How to Administrate Rill] : Administrative tasks from the CLI and UI that an administrator would need to know to be a Rill Administrator
- [Rill's Cloud and Advanced Features] : In-depth of Rill Cloud Features and hands-on with Advanced Features
- [Rill and ClickHouse] : For our friends coming from ClickHouse, get started in **4 steps**.

</div>
## Quick Starts & Examples

If you need a reference point to get started, you can download our [example repository](https:/rilldata/rill-examples/).

Some of the included projects are:

- [App Engagement](https:/rilldata/rill-examples/tree/main/rill-app-engagement): a conversion dataset used by marketers, mobile developers or product teams to analyze funnel steps
- [Cost Monitoring](https:/rilldata/rill-examples/tree/main/rill-cost-monitoring): based off of Rill's own internal dashboards, cloud infrastructure data (compute, storage, pipeline statistics, etc.) merged with customer data to analyze bottlenecks and look for efficiencies
- [GitHub Analytics](https:/rilldata/rill-examples/tree/main/rill-github-analytics): analyze GitHub activity to understand what parts of your codebase are most active, analyze contributor productivity, and evaluate the intersections between commits and files
- [Programmatic Ads/OpenRTB](https:/rilldata/rill-examples/tree/main/rill-openrtb-prog-ads): bidstream data for programmtic advertisers to optimize pricing strategies, look for inventory opportunities, and improve campaign performance
- [311 Operations](https:/rilldata/rill-examples/tree/main/rill-311-ops): a live datastream of 311 call centers from various locations in the US for example operational analytics
- [Final Tutorial Project](https:/rilldata/rill-examples/tree/main/my-rill-tutorial): A finalized version of the tutorial project with many working examples, a good place to reference any newer features, updated regularly.


## Release Notes

If you need information on our latest releases, check out our [release notes!](https://docs.rilldata.com/notes)

## Don't be a stranger!
We always appreciate hearing from our users and welcome any questions, comments, or concerns you may have. To get in touch with us, there are a few options available:
Expand Down
Loading

0 comments on commit 11838e6

Please sign in to comment.