Skip to content

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

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

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

Conversation

@ijac13
Copy link
Contributor

@ijac13 ijac13 commented Feb 27, 2026

Summary

  • Add environment-setup.md with CI/CD workflow explanation and profiles.yml configuration
  • Create environment-best-practices.md with strategies for per-PR schemas, staging, data range limits, and cleanup
  • 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

Files Changed

File Action
environment-setup.md Updated with CI/CD workflow intro
environment-best-practices.md New (from best-practices-prep-env.md)
setup-cd.md Moved from 7-cicd/
setup-ci.md Moved from 7-cicd/

Related

  • Part of docs v3 migration
  • See migration plan: recce-content-guide/drafts/docs/recce-docs-v3-migration-plan.md

🤖 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>
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.

1 participant