Skip to content

Commit

Permalink
Docs deploy change (#5600)
Browse files Browse the repository at this point in the history
* Getting started on revising the rill deploy changes,

Waiting for nightly to test rill project upload and rill project connect-github

* Changed Dashboard deploy page and naming

* minor changes

* Update 0.49.md

* fixing some broken links

* rill project deploy commands changes

As discussed, some changes to rill deploy commands, updated the examples.

Likewise, added a deprecated section at the ending that refers back to the main section of what its similar to.
  • Loading branch information
royendo authored Sep 18, 2024
1 parent 27a246c commit 4a1ce64
Show file tree
Hide file tree
Showing 36 changed files with 268 additions and 223 deletions.
4 changes: 2 additions & 2 deletions docs/blog/0.26.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Many Rill users have asked us how they can share what they have built in Rill wi

With one simple command, `rill deploy`, you are able to launch your project dashboards to an online endpoint. This endpoint can be protected and "invite only" for your collaborators or it can be a public website shared with the world.

- **Self-serve local project deployment with the CLI - ** [Deploying a project](../../deploy/existing-project) makes dashboards available online and enables you to invite others to access it without installing Rill locally. To try deploying your project `cd` into the project's root directory and run `rill deploy`.
- **Self-serve local project deployment with the CLI - ** [Deploying a project](../../deploy/deploy-dashboard/) makes dashboards available online and enables you to invite others to access it without installing Rill locally. To try deploying your project `cd` into the project's root directory and run `rill deploy`.

- **User management with the CLI - ** In Rill Cloud, access can be granted at the organization or project level using the Rill CLI. You can grant access to a private dashboard using `rill user add`
- **Viewers** can browse projects and view dashboards.
- **Admins** can deploy projects, make changes to existing projects, or delete deployed projects. They can also manage members of an organization by granting or revoking access to other users. The person deploying the project for the first time is an Admin by default.

- **Continuous deployment with Github - ** Rill connects to a repository on Github containing a Rill project, and [continuously deploys](/deploy/existing-project) that project. This means that every change you push to your primary branch in Github will be automatically picked up by Rill and update the hosted endpoint. This workflow enables you to use best practices in Git workflows as well as frictionless deployment to your production environment.
- **Continuous deployment with Github - ** Rill connects to a repository on Github containing a Rill project, and [continuously deploys](/deploy/deploy-dashboard/) that project. This means that every change you push to your primary branch in Github will be automatically picked up by Rill and update the hosted endpoint. This workflow enables you to use best practices in Git workflows as well as frictionless deployment to your production environment.

- **New welcome screen in Rill local - ** We are excited to get the word out that Rill Beta is open and expect to have more people taking the data to deployed dashboard journey with us. To welcome new users, we made a beautiful new welcome splash screen in the application that helps people take their first step -- adding data they care about. We think this will be a great space to share more examples projects in the future.

Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.42.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 42](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/0.41_bookmarks_alerts.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.43.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

## Slack Alerts
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.44.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 44](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/0.44.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.45.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 45](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/release-045.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.46.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 46](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/release-046.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.47.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 47](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/release-notes-047.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.48.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard/) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 48](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/release-048.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/blog/0.49.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ image: https://github.com/rilldata/rill/assets/5587788/b30486f6-002a-445d-8a1b-9
:::note
⚡ Rill Developer is a tool that makes it effortless to transform your datasets with SQL and create fast, exploratory dashboards. Rill Cloud can then help to enable shared collaboration at scale.

To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/existing-project) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
To [try out Rill Developer, check out these instructions](/home/install) and [join us over on Discord](https://bit.ly/3bbcSl9) to meet the team behind the product as well as other users. In addition, once you have a project set up in Rill Developer, you can then [deploy the project](/deploy/deploy-dashboard) and collaborate with others / invite your team members by [logging into Rill Cloud](https://ui.rilldata.com)!
:::

![release-0 49](<https://storage.googleapis.com/prod-cdn.rilldata.com/docs/release-notes/release-049.gif>)
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/build/connect/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ For more details about configuring and/or changing the OLAP engine used by Rill,

## Rill Developer vs Rill Cloud

_There is a difference_ between Rill Developer and Rill Cloud and they work hand-in-hand to provide a shared experience. For distributed teams, Rill Developer is primarily meant for local development and modeling purposes while Rill Cloud is where the primary dashboard consumption occurs and helps to enable shared collaboration at scale. For Rill Developer, as the size or volume of source data continues to grow (or reaches a certain size), it is strongly recommended to [work with a segment of the data for modeling purposes](../../deploy/performance.md#work-with-a-subset-of-your-source-data-for-local-development-and-modeling) instead of the full dataset (i.e. think of it as a "dev partition"), which is meant to help the developer validate the model logic and verify that the correct results are being produced. Then, after the [model](../models/models.md) and [dashboard](../dashboards/dashboards.md) configurations have been finalized, the project can be [deployed to Rill Cloud](../../deploy/existing-project/existing-project.md) against the full range of data and dashboards can be [explored](../../explore/dashboard-101.md) by other end users.
_There is a difference_ between Rill Developer and Rill Cloud and they work hand-in-hand to provide a shared experience. For distributed teams, Rill Developer is primarily meant for local development and modeling purposes while Rill Cloud is where the primary dashboard consumption occurs and helps to enable shared collaboration at scale. For Rill Developer, as the size or volume of source data continues to grow (or reaches a certain size), it is strongly recommended to [work with a segment of the data for modeling purposes](../../deploy/performance.md#work-with-a-subset-of-your-source-data-for-local-development-and-modeling) instead of the full dataset (i.e. think of it as a "dev partition"), which is meant to help the developer validate the model logic and verify that the correct results are being produced. Then, after the [model](../models/models.md) and [dashboard](../dashboards/dashboards.md) configurations have been finalized, the project can be [deployed to Rill Cloud](../../deploy/deploy-dashboard/) against the full range of data and dashboards can be [explored](../../explore/dashboard-101.md) by other end users.

:::info Have questions?

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/build/connect/multiple-connectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Multiple Connectors
sidebar_position: 20
---

Sometimes, you will need to set up multiple connectors of the same type in one project with different connection strings (DSN) or configurations for sources. A common example would be that you have a need for multiple [Snowflake](/reference/connectors/snowflake.md) sources that point to different databases and schemas. Therefore, when [deploying your project to Rill Cloud](/deploy/existing-project/#deploy-to-rill-cloud), you will want to specify multiple `snowflake.connector.dsn` connection strings, one corresponding to each unique "connection" you desire (with different connection parameters).
Sometimes, you will need to set up multiple connectors of the same type in one project with different connection strings (DSN) or configurations for sources. A common example would be that you have a need for multiple [Snowflake](/reference/connectors/snowflake.md) sources that point to different databases and schemas. Therefore, when [deploying your project to Rill Cloud](/deploy/deploy-dashboard/#deploying-a-project-via-the-ui), you will want to specify multiple `snowflake.connector.dsn` connection strings, one corresponding to each unique "connection" you desire (with different connection parameters).

## Defining multiple connectors in `rill.yaml`

Expand Down
3 changes: 1 addition & 2 deletions docs/docs/build/connect/source-refresh.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ When creating or updating a source in Rill Cloud, you also have the option to co

:::tip Configuring source refreshes for Cloud deployments

It is generally strongly recommended to configure source refreshes when [deploying a project](/deploy/existing-project/existing-project.md) to Rill Cloud to ensure that your production data (and dashboards) _remains up-to-date_. The interval that you should set really depends on how often your own source data is refreshed. Automatic scheduled refreshes are not applied in Rill Developer by default since it typically does not require working with the most up-to-date data (local source refreshes that occur too often as well could also lead to resource constraints on your local machine). For more details, please see our pages on [environments](/build/models/environments#default-dev-and-prod-environments), [templating](/deploy/templating#environments-and-rill), and [performance optimization](/deploy/performance#configure-source-refresh-schedules-in-production-only).

It is generally strongly recommended to configure source refreshes when [deploying a project](/deploy/deploy-dashboard/) to Rill Cloud to ensure that your production data (and dashboards) _remains up-to-date_. The interval that you should set really depends on how often your own source data is refreshed. Furthermore, while it is technically possible to configure source refreshes for Rill Developer as well, Rill Developer is primarily used for local development and thus typically does not require working with the most up-to-date data (local source refreshes that occur too often as well could also lead to resource constraints on your local machine). For more details, please see our pages on [environments](/build/models/environments#default-dev-and-prod-environments), [templating](/deploy/templating#environments-and-rill), and [performance optimization](/deploy/performance).
:::

## Configuring source refresh individually
Expand Down
Loading

1 comment on commit 4a1ce64

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.