Skip to content

Commit 30839fa

Browse files
authored
Merge pull request #3 from DataRecce/update-cloud-overview
update overview of Recce Cloud
2 parents 79e1d22 + c6ebab1 commit 30839fa

File tree

1 file changed

+12
-20
lines changed

1 file changed

+12
-20
lines changed

docs/recce-cloud/index.md

Lines changed: 12 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,31 @@ title: Overview
33
icon: material/hand-wave-outline
44
---
55

6-
!!! Note
7-
8-
Recce Cloud is currently in **private alpha** and scheduled for general availability later this year. [Sign up](../cloud.md#signup) to the Recce newsletter to be notified, or email [[email protected]](mailto:[email protected]) to join our design partnership program for early access.
9-
10-
## What is `Recce Cloud`?
11-
12-
Recce Cloud is a service specifically designed for streamlining the DBT PR Review workflow.
13-
14-
Recce Cloud primarily operates through [Recce](../index.md) and integrates GitHub Pull Requests, consolidating the review status of PRs within the Cloud. Without Recce Cloud, we use the [state file](http://localhost:5678/docs/features/state-file/) to store PR review states. However, this method is not very suitable for collaboration or integration with CI because our review states are not stored in a fixed location. Recce Cloud is designed to solve this problem.
6+
## What is Recce Cloud?
7+
Recce Cloud is a data collaboration platform for teams doing data validation, impact analysis, and pull requests reviews. It helps data teams catch issues early, understand downstream impacts, and communicate changes clearly—all in one shared workspace. Instead of working alone in a local dev environment, teams can explore lineage, run custom queries, and validate metrics together, speeding up reviews and building trust across stakeholders.
158

9+
<!-- - [Learn more about different plans](https://datarecce.io/pricing) -->
10+
- Follow the [Getting Started](/get-started/) guide
1611

17-
## Prerequisite
12+
## Integration with GitHub
13+
Recce Cloud integrates with GitHub to support validation in your PR workflow. The following instructions provide an overview of the setup. For a hands-on walkthrough, check out the [Jaffle Shop Tutorial for Cloud](./getting-started-recce-cloud.md).
1814

19-
1. Recce Cloud requires [Recce](../index.md). Please make sure that you have understood how use Recce in your dbt project.
20-
1. Prepare the github personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable.
15+
### Prerequisite
16+
1. Sign in [Recce cloud](https://cloud.datarecce.io/)
17+
2. Click **Install** button to install Recce Cloud github app to your personal or organization account.
18+
3. Authorize the repositories to the github app.
19+
4. Prepare the github personal access token with the `repo` permission. Please see the [GitHub document](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). And set it to your environment variable.
2120
```
2221
export GITHUB_TOKEN=<token>
2322
```
2423
Or you can set the `--cloud-token <GITHUB_TOKEN>` command option.
25-
1. Prepare the Recce state password. The Recce state password is used to encrypt/decrypt the state file before uploading/downloading. The password is not stored in Recce Cloud, so you need to keep it safe.
24+
5. Prepare the Recce state password. The Recce state password is used to encrypt/decrypt the state file before uploading/downloading. The password is not stored in Recce Cloud, so you need to keep it safe.
2625
```
2726
export RECCE_STATE_PASSWORD=<password>
2827
```
2928
Or you can set the `--password <password>` or `-p <password>` command option.
3029

31-
## Getting Started
32-
The following instructions give an overview of the process of using Recce in your dbt project. For a hands-on tutorial, please check the [Jaffle Shop Tutorial for Cloud](./getting-started-recce-cloud.md).
3330

34-
### Sign Up the Recce Cloud
35-
1. Go to the [recce cloud](https://cloud.datarecce.io/)
36-
2. Sign in by github account
37-
3. Click **Install** button to install Recce Cloud github app to your personal or organization account.
38-
4. Authorize the repositories to the github app.
3931

4032
### Launch the `recce server` in the cloud mode
4133

0 commit comments

Comments
 (0)