Skip to content

PR 2b: Environment Setup + Best Practices + CI/CD Pages#73

Open
ijac13 wants to merge 13 commits intodocs-v3from
pr2b-environment-setup
Open

PR 2b: Environment Setup + Best Practices + CI/CD Pages#73
ijac13 wants to merge 13 commits intodocs-v3from
pr2b-environment-setup

Conversation

@ijac13
Copy link
Contributor

@ijac13 ijac13 commented Feb 27, 2026

Summary

Create environment setup and best practices guides for users with advanced environment configurations or using GitLab CI/CircleCI. Move setup-cd.md and setup-ci.md to Getting Started section.

Scope

Path Action Doc Type Notes
2-getting-started/environment-setup.md Create Tutorial Technical how-to for profiles.yml, env vars, patterns
2-getting-started/environment-best-practices.md Create Concept Strategic guidance from best-practices-prep-env.md
2-getting-started/setup-cd.md Move Tutorial From 7-cicd/ for GitLab/CircleCI users
2-getting-started/setup-ci.md Move Tutorial From 7-cicd/ for GitLab/CircleCI users
7-cicd/ci-cd-getting-started.md Delete - Content absorbed into environment-setup
7-cicd/best-practices-prep-env.md Delete - Replaced by environment-best-practices.md

Quality Checks

Check Issues Status
QA 2 minor: expected outcomes per step, recency signal ✅ Passed
AISEO 1 minor: recency signal ✅ Passed
Redirects 4 redirects configured ✅ Complete
Checklist All items verified ✅ Complete

Redirects

Old URL New URL Status
7-cicd/setup-cd.md 2-getting-started/setup-cd.md ✅ Added
7-cicd/setup-ci.md 2-getting-started/setup-ci.md ✅ Added
7-cicd/ci-cd-getting-started.md 2-getting-started/environment-setup.md ✅ Added
7-cicd/best-practices-prep-env.md 2-getting-started/environment-best-practices.md ✅ Added

Content Changes

Before → After

File Before After Review
environment-setup.md Did not exist Tutorial: configure profiles.yml and CI/CD env vars for Recce ✅ As planned
environment-best-practices.md Content was in 7-cicd/best-practices-prep-env.md Concept: per-PR schemas, staging strategy, data range, cleanup ✅ As planned
setup-cd.md Located in 7-cicd/ Moved to 2-getting-started/, links updated ✅ As planned
setup-ci.md Located in 7-cicd/ Moved to 2-getting-started/, links updated ✅ As planned
ci-cd-getting-started.md Intro to CI/CD concepts Deleted - content absorbed into environment-setup ✅ As planned
best-practices-prep-env.md Environment strategies Deleted - replaced by environment-best-practices.md ✅ 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 checks passed with minor issues. All 4 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 6 commits February 27, 2026 21:28
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- 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
- 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
- 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>
ijac13 and others added 7 commits March 2, 2026 11:00
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>
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>
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.

Technical parts LGTM.
But I'm not sure if there is a better form for "Environment Best Practices". It's a little bit scatter for me.

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