Docs v3: Rewrite start-free-with-cloud as overview + router page#87
Open
doriwilson wants to merge 62 commits intomainfrom
Open
Docs v3: Rewrite start-free-with-cloud as overview + router page#87doriwilson wants to merge 62 commits intomainfrom
doriwilson wants to merge 62 commits intomainfrom
Conversation
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Tutorial for setting up Recce Cloud when dbt runs on dbt Cloud, covering artifact retrieval via dbt Cloud API and GitHub Actions workflow configuration. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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>
- Restructure setup guidance into nested decision tree - Question 1: Where dbt runs (self-hosted vs dbt Cloud) - If self-hosted: sub-options for GitHub Actions vs GitLab/CircleCI - Question 2: Environment complexity (simple vs advanced) - Link to dbt Cloud Setup for platform users - Link to Environment Setup for advanced configurations
- Update environment-setup.md with CI/CD workflow explanation - Create environment-best-practices.md (from best-practices-prep-env.md) - Move setup-cd.md to 2-getting-started (for GitLab/CircleCI users) - Move setup-ci.md to 2-getting-started (for GitLab/CircleCI users) - Update internal links to new locations
- Add dbt Cloud Setup to mkdocs.yml navigation - Update setup-cd and setup-ci links to new location (2-getting-started/)
- Remove 'advanced configuration' framing - this is basic setup - Reorder: 'Why separate schemas' before 'How CI/CD works' - Reduce profiles.yml to single example with note for other warehouses - Shorten CI/CD env var examples (full workflows in setup-cd/ci) - Recommend schema-per-PR as primary pattern - Add 'not recommended' warning for shared dev schema - Add pros AND cons for staging-as-base pattern
- setup-cd: References environment-setup, clarifies main branch uses prod target - setup-ci: References environment-setup, clarifies per-PR schema with ci target - Both link to environment-setup.md for profiles.yml configuration
- Add problem statement to dbt-cloud-setup opening - Remove redundant content between intro and goal - Spell out PR and CI/CD acronyms on first use - Fix "bolded steps" references to explicit commands - Improve image alt text for accessibility - Rename "Related" to "Next steps" with descriptive links Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Standardize PR terminology (remove PR/MR references) - Add problem statements to openings - Improve image alt text for accessibility - Define key terms inline (base/current environment) - Add "When to use this guide" section to best practices - Rename "Related" to "Next steps" - Spell out CI/CD acronyms on first use 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>
- Create 3-using-recce/admin-setup.md: Organization setup tutorial - Delete 6-collaboration/invitation.md (replaced by admin-setup) - Update navigation in mkdocs.yml Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- 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>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add mkdocs-redirects plugin to requirements.txt - Add redirects for 7-cicd/ → 2-getting-started/ paths - Fix broken link to dbt-cloud-setup.md in environment-best-practices.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove old 7-cicd/setup-cd.md and setup-ci.md from nav (moved to Getting Started) - Update links in start-free-with-cloud.md to point to new locations - Update links in ci-cd-getting-started.md to point to new locations - Delete old setup-cd.md and setup-ci.md from 7-cicd/ Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add step 4 "Rename your project (optional)" with updated instructions - Renumber "Invite team members" to step 5 - Add step 6 telling admins to inform invitees about acceptance modal - Remove redundant "Additional Settings > Rename your project" section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
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>
- data-developer.md: Dev sessions (before PR) and CI/CD validation (after PR) - data-reviewer.md: Review data changes using Recce summaries Part of docs v3 migration - PR4 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add mkdocs-redirects plugin with redirect mappings for all restructured pages - PR 6: Lineage and data diffing → 5-what-you-can-explore/ - PR 7: preset-checks.md → 6-collaboration/ - PR 8: Technical concepts → 7-reference/ - PR 9: Community support → 8-community/ - Create CLEANUP-TODO.md documenting files to delete after all PRs merge Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Create new 8-community section containing: - support.md: Consolidated community resources (Discord, Slack, GitHub, social media) - changelog.md: Links to release notes and detailed blog posts Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…tation - Create 7-reference/configuration.md: Document recce.yml preset check configuration with overview, parameters, and examples for all check types - Create 7-reference/state-file.md: Document state file format, saving methods, and usage patterns for development and PR review workflows - Create 7-reference/cli-reference.md: Document recce and recce-cloud CLI commands including server, run, summary, debug, and upload - Update mkdocs.yml: Rename "Technical Concepts" to "Reference" and update navigation paths to new 7-reference section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add dbt Cloud setup guide
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR 2b: Environment Setup + Best Practices + CI/CD Pages
PR2d: Add OSS setup guides and Cloud vs OSS comparison Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
PR3: Add admin setup guide for team collaboration Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR5: Add What the Agent Does section Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
docs(v3): Add data developer and reviewer workflow guides Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Add Community section with support and changelog pages Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Reference section with CLI, configuration, and state file documentation Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
PR 10: Cleanup and redirects Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Consolidate feature pages into new 5-what-you-can-explore section: - lineage-diff.md (from 3-visualized-change/lineage.md) - code-change.md (from 3-visualized-change/) - column-level-lineage.md (from 3-visualized-change/) - multi-models.md (from 3-visualized-change/) - impact-radius.md (from 4-downstream-impacts/) - breaking-change-analysis.md (from 4-downstream-impacts/) - data-diffing.md (consolidated from 5-data-diffing/) Update mkdocs.yml navigation and add redirects for old paths. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Change lineage.md references to lineage-diff.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add missing sections to concept docs: - breaking-change-analysis.md: When to Use, Related - code-change.md: When to Use, Related - column-level-lineage.md: When to Use, Related - impact-radius.md: When to Use - multi-models.md: When to Use, Related Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
PR6: Add What You Can Explore section
- checklist.md: Add "When to use" section, restructure as concept - share.md: Add Goal, Prerequisites, Verification sections - preset-checks.md: Copy from 7-cicd/, add Goal/Prerequisites/Verification Part of docs v3 migration - PR7 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- checklist.md: Add link to Preset Checks in Re-running Checks section - share.md: Restructure with Recce Cloud first (URL sharing), OSS methods second - preset-checks.md: Restructure with Recce Cloud first (UI-based), OSS (recce.yml) second - mkdocs.yml: Remove duplicate preset-checks entry from CI/CD nav Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
docs(v3): Update collaboration pages
- Reduce from 351 to 160 lines by removing duplicated YAML blocks - Replace inline profiles.yml, base-workflow.yml, pr-workflow.yml with links to dedicated pages (environment-setup, setup-cd, setup-ci) - Fix CI_SCHEMA → SNOWFLAKE_SCHEMA in environment-setup.md for consistency - Add breadcrumb admonitions to spoke pages (environment-setup, setup-cd, setup-ci) for onboarding navigation - Fix workflow name mismatch in setup-cd.md verification step - Update router table to use plain text instead of self-referencing anchors Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR rewrites
start-free-with-cloud.mdfrom a ~350-line mega-page into a ~160-line overview + router page. The previous version duplicated YAML code blocks and configuration instructions already covered by dedicated setup pages. The rewrite removes all duplication and routes users to spoke pages instead.CI_SCHEMA→SNOWFLAKE_SCHEMA)What changed vs earlier docs-v3
start-free-with-cloud.md(primary rewrite)Removed:
profiles.ymlYAML block + explanation (~40 lines) — already inenvironment-setup.mdbase-workflow.ymlYAML block + explanation (~55 lines) — already insetup-cd.mdpr-workflow.ymlYAML block + explanation (~55 lines) — already insetup-ci.mdreccevsrecce-cloudverbose admonition — condensed to one sentenceReplaced with:
environment-setup.md,setup-cd.md,setup-ci.mdconnect-to-warehouse.md,connect-git.mdKept unchanged:
environment-setup.mdCI_SCHEMA→SNOWFLAKE_SCHEMAin profiles.yml example (line 66), env var snippets (lines 96, 103), and prose (lines 84, 109)pr_123→PR_123in prose to match actual YAML output casingsetup-cd.mdname: Update Base Metadata— updated to matchsetup-ci.mdgitlab-pat-guide.md#2-connect-git-providerstill resolves correctlyReview notes
Test plan
mkdocs serverenders all 4 changed pages without warningsstart-free-with-cloud.md#3-add-recce-to-cicdand#2-connect-git-provideranchors)🤖 Generated with Claude Code