Skip to content

Commit f3a8bea

Browse files
committed
modify some wording
1 parent ef79ef4 commit f3a8bea

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

docs/7-cicd/setup-cd.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ Automated continuous deployment (CD) for Recce Cloud base session updates. Ensur
1010
1111
## Purpose
1212

13-
**Automated Base Session Management** → Eliminates manual baseline maintenance
13+
**Automated Base Session Management** eliminates manual baseline maintenance.
1414

1515
- **Triggers**: PR merge to main + scheduled updates
1616
- **Action**: Auto-update base Recce session
1717
- **Benefit**: Current comparison baseline for future PRs
1818

19+
## Prerequisites
20+
21+
You need `manifest.json` and `catalog.json` files (dbt artifacts) for Recce Cloud. See [Start Free with Cloud](../2-getting-started/start-free-with-cloud.md) for instructions on preparing these files.
22+
1923
## Implementation
2024

2125
### 1. Core Workflow
@@ -77,15 +81,14 @@ jobs:
7781

7882
**Default: Fresh Build** (shown in example above)
7983

80-
- `dbt docs generate` → Required (provides all needed artifacts)
81-
- `dbt build` → Optional (ensures tables are materialized and updated)
84+
- `dbt docs generate` is required and provides the needed `manifest.json` and `catalog.json` artifacts.
85+
- `dbt build` is optional but ensures tables are materialized and updated.
8286

8387
**Alternative Methods:**
8488

8589
- **External Download**: Download from dbt Cloud, Paradime, or other platforms
8690
- **Pipeline Integration**: Use existing dbt build workflows
8791

88-
**Key Requirement**: `manifest.json` and `catalog.json` available for Recce Cloud upload.
8992

9093
### 3. Verification
9194

@@ -105,5 +108,4 @@ jobs:
105108

106109
## Next Steps
107110

108-
-**CD Setup Complete** → Base sessions auto-update on merge + schedule
109-
- 🔄 **Add CI**: [Setup CI](./setup-ci.md) for PR validation
111+
**[Setup CI](./setup-ci.md)** to automatically validate PR changes against your updated base session. This completes your CI/CD pipeline by adding automated data validation for every pull request.

docs/7-cicd/setup-ci.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ Automated data validation for pull requests using Recce Cloud. Catch data issues
1010
1111
## Purpose
1212

13-
**Automated PR Validation** → Prevent data regressions before merge
13+
**Automated PR Validation** prevents data regressions before merge.
1414

1515
- **Triggers**: PR opened/updated against main
1616
- **Action**: Auto-update Recce session for PR validation
1717
- **Benefit**: Automated data validation and comparison
1818

19+
## Prerequisites
20+
21+
You need `manifest.json` and `catalog.json` files (dbt artifacts) for Recce Cloud. See [Start Free with Cloud](../2-getting-started/start-free-with-cloud.md) for instructions on preparing these files.
22+
1923
## Implementation
2024

2125
### 1. Core Workflow
@@ -77,16 +81,14 @@ jobs:
7781

7882
**Default: Fresh Build** (shown in example above)
7983

80-
- `dbt docs generate` → Required (provides all needed artifacts)
81-
- `dbt build` → Optional (ensures tables are materialized and updated)
84+
- `dbt docs generate` is required and provides all needed artifacts.
85+
- `dbt build` is optional but ensures tables are materialized and updated.
8286

8387
**Alternative Methods:**
8488

8589
- **External Download**: Download from dbt Cloud, Paradime, or other platforms
8690
- **Pipeline Integration**: Use existing dbt build workflows
8791

88-
**Key Requirement**: `manifest.json` and `catalog.json` available for Recce Cloud action.
89-
9092
### 3. Verification
9193

9294
#### Test with a PR
@@ -106,6 +108,6 @@ jobs:
106108

107109
To analyze the PR changes in detail:
108110

109-
- Go to your Recce Cloud dashboard
111+
- Go to your [Recce Cloud dashboard](https://cloud.reccehq.com)
110112
- Find the PR session that was created
111113
- Launch Recce instance to explore data differences

0 commit comments

Comments
 (0)