Skip to content

PR2d: Add OSS setup guides and Cloud vs OSS comparison#75

Open
ijac13 wants to merge 7 commits intodocs-v3from
pr2d-oss-setup
Open

PR2d: Add OSS setup guides and Cloud vs OSS comparison#75
ijac13 wants to merge 7 commits intodocs-v3from
pr2d-oss-setup

Conversation

@ijac13
Copy link
Contributor

@ijac13 ijac13 commented Mar 1, 2026

Summary

Create OSS setup guide, Jaffle Shop tutorial, and Cloud vs OSS comparison. For users who want to use Recce locally (single user, not team CI/CD).

Scope

Path Action Doc Type Notes
2-getting-started/oss-setup.md Create Tutorial Setup guide for Recce OSS
2-getting-started/jaffle-shop-tutorial.md Create Tutorial Hands-on tutorial with DuckDB
1-whats-recce/cloud-vs-oss.md Create Concept Feature comparison, moved from section 2
2-getting-started/oss-vs-cloud.md Delete - Replaced by cloud-vs-oss.md
2-getting-started/get-started-jaffle-shop.md Delete - Replaced by jaffle-shop-tutorial.md
2-getting-started/installation.md Delete - Content consolidated into oss-setup.md

Quality Checks

Check Issues Status
QA No issues ✅ Passed
AISEO No issues ✅ Passed
Redirects 3 redirects configured ✅ Complete
Checklist All items verified ✅ Complete

Redirects

Old URL New URL Status
2-getting-started/installation.md 2-getting-started/oss-setup.md ✅ Added
2-getting-started/get-started-jaffle-shop.md 2-getting-started/jaffle-shop-tutorial.md ✅ Added
2-getting-started/oss-vs-cloud.md 1-whats-recce/cloud-vs-oss.md ✅ Added

Content Changes

Before → After

File Before After Review
oss-setup.md Did not exist Tutorial: install and run Recce OSS locally ✅ As planned
jaffle-shop-tutorial.md Content was in get-started-jaffle-shop.md Tutorial: hands-on with jaffle_shop_duckdb ✅ As planned
cloud-vs-oss.md Content was in oss-vs-cloud.md Concept: feature comparison, moved to section 1 ✅ As planned
installation.md Generic install instructions Deleted - content in oss-setup.md ✅ As planned
get-started-jaffle-shop.md Jaffle Shop tutorial Deleted - replaced by jaffle-shop-tutorial.md ✅ As planned
oss-vs-cloud.md Cloud vs OSS comparison Deleted - replaced by cloud-vs-oss.md in section 1 ✅ As planned

Review status:

  • ✅ As planned — Change matches migration plan exactly

Change Review

I reviewed all changes and confirm:

  • All CREATE files contain intended new content
  • All DELETE files have content preserved elsewhere or are intentionally removed
  • All UPDATE files have only intended modifications
  • All MOVE/DELETE actions have redirects configured
  • Navigation updates match the intended structure
  • No unintended changes to other files

Review notes: QA and AISEO passed. All 3 redirects configured in mkdocs.yml.

Test plan

  • Verify navigation links work in local preview
  • Check all cross-references resolve correctly
  • Confirm images render properly

🤖 Generated with Claude Code

ijac13 and others added 5 commits February 27, 2026 21:51
Helps users identify their setup path:
- Own dbt run vs platform (dbt Cloud)
- Simple vs advanced environment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Create oss-setup.md: OSS installation and local validation guide
- Create jaffle-shop-tutorial.md: Hands-on tutorial with DuckDB
- Create cloud-vs-oss.md: Cloud vs Open Source comparison
- Delete old oss-vs-cloud.md and get-started-jaffle-shop.md
- Update navigation in mkdocs.yml

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ijac13 ijac13 changed the title docs(v3): Add OSS setup guides and Cloud vs OSS comparison Add OSS setup guides and Cloud vs OSS comparison Mar 1, 2026
@ijac13 ijac13 changed the title Add OSS setup guides and Cloud vs OSS comparison PR2d: Add OSS setup guides and Cloud vs OSS comparison Mar 1, 2026
ijac13 and others added 2 commits March 2, 2026 10:59
- Fix MCP link in cloud-vs-oss.md
- Change prerequisites to checked format [x]
- Change "dbt models" to "data models" for broader audience
- Remove installation.md (content covered in oss-setup.md)
- Update mkdocs.yml navigation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Redirects:
- installation.md → oss-setup.md
- get-started-jaffle-shop.md → jaffle-shop-tutorial.md
- oss-vs-cloud.md → cloud-vs-oss.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ijac13 ijac13 requested review from doriwilson and even-wei March 2, 2026 03:14
@ijac13
Copy link
Contributor Author

ijac13 commented Mar 2, 2026

here are some URL issues: Issues to fix:

  1. cloud-vs-oss.md (lines 124-125) - Links to non-existent files:
    - ../5-what-the-agent-does/index.md
    - ../3-using-recce/data-developer.md
  2. start-free-with-cloud.md - Cross-PR links will work after merge:
    - dbt-cloud-setup.md (PR2c)
    - environment-setup.md (PR2b)

will have another PR at the end to clean up when all PRs are merged

Copy link
Contributor

@even-wei even-wei left a comment

Choose a reason for hiding this comment

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

Overall, LGTM.
Should we use DataRecce/jaffle_shop_duckdb rather than dbt-labs/jaffle_shop_duckdb?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants