Skip to content

Commit eac1158

Browse files
committed
modify upload files
1 parent c0bd8ce commit eac1158

File tree

1 file changed

+26
-25
lines changed

1 file changed

+26
-25
lines changed

docs/2-getting-started/start-free-with-cloud.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,27 @@ title: Start free with Cloud
1010

1111
## Model Changes and Impact Analysis
1212

13-
Recce shows what changed between **base** and **current** environments and helps assess potential impact.
13+
Recce shows what changed between **base** and **current** environments and helps assess potential impact. The most common case is comparing your development branch against your production or main branch to see what your changes will impact.
1414

15-
**Upload your metadata:**
15+
You can:
1616

17-
1. Click "Update" in base session to upload baseline metadata
18-
2. Click "Update" in current session to upload comparison metadata
19-
3. Click "Launch" to compare current against base
20-
21-
**Or explore with sample data:** Skip uploads and launch with pre-loaded sample data.
17+
- Explore with the pre-loaded Jaffle Shop data
18+
- Upload your metadata (see below)
19+
- **Skip manual upload go directly to [CI/CD automation](#cicd-automation)**
2220

2321
<!-- insert a video -->
2422

23+
### Upload Metadata
24+
- Web interface: Click "Update" on the session you want to update in Recce Cloud.
25+
1. Click "Update" in base session to upload baseline metadata
26+
2. Click "Update" in current session to upload comparison metadata
27+
3. Click "Launch" to compare current against base
28+
- CLI command:
29+
```
30+
recce upload-session --session-id <your_session_id>
31+
```
32+
Find your session ID in Recce Cloud web interface when clicking "Update" on any session.
33+
2534
### Required Files
2635

2736
Recce needs `manifest.json` and `catalog.json` from both **base** and **current** environments for comparison.
@@ -64,15 +73,6 @@ dbt docs generate --target <your_dev_target>
6473
Deploy → Jobs → CI job → Recent run → Download artifacts
6574

6675

67-
### Upload Files
68-
- Web interface: Click "Update" on the session you want to update in Recce Cloud.
69-
- CLI command:
70-
```
71-
recce upload-session --session-id <your_session_id>
72-
```
73-
Find your session ID in Recce Cloud web interface when clicking "Update" on any session.
74-
75-
7676
## Data Warehouse Diffing {#data-diffing}
7777

7878
Go beyond metadata to see how changes affect your actual data. Configure your data warehouse connection to compare query results and catch issues before they impact production.
@@ -122,7 +122,8 @@ Connect your GitHub repo to see all PRs in one place and validate changes before
122122
- Repository admin access for initial setup
123123
- Active PRs with model changes
124124

125-
**Note:** You'll need administrative access to the GitHub organization you want to connect. Please ensure you have the necessary permissions for **GitHub App installations**.
125+
!!!Note
126+
You'll need administrative access to the GitHub organization you want to connect. Please ensure you have the necessary permissions for **GitHub App installations**.
126127

127128
### GitHub Connection
128129

@@ -151,9 +152,16 @@ Once connected, Recce displays all open and draft PRs in your dashboard.
151152

152153
## CI/CD Automation {#cicd-automation}
153154

154-
Set up CI/CD to automatically upload metadata and run validation checks on every PR. Available with Team plan (free trial included).
155+
Set up CI/CD to automatically upload metadata and run validation checks on every PR.
156+
157+
!!!Note
158+
Available with Team plan (free trial included).
155159

156160
### Setup Requirements
161+
See the CI/CD sections for complete setup guides:
162+
163+
- [Setup CD](/7-cicd/setup-cd/)
164+
- [Setup CI](/7-cicd/setup-ci/)
157165

158166
- GitHub integration configured
159167
- Team plan subscription or free trial
@@ -166,13 +174,6 @@ Set up CI/CD to automatically upload metadata and run validation checks on every
166174
- Integrated PR status checks
167175
- Validation results directly in PR
168176

169-
### Team Plan Trial
170177

171-
Start your free trial to access CI/CD automation features. No credit card required for trial period.
172178

173-
### Setup Details
174179

175-
See the CI/CD sections for complete setup guides:
176-
177-
- [Setup CD](/7-cicd/setup-cd/)
178-
- [Setup CI](/7-cicd/setup-ci/)

0 commit comments

Comments
 (0)