Guides¶
Step-by-step operational playbooks. Each guide is a repeatable procedure with clear prerequisites, commands, and expected outcomes.
Index¶
| Guide | When to use it |
|---|---|
| Bootstrap Setup | First-time Snowflake environment setup |
| New Client Onboarding | Onboarding a new client end-to-end |
| New Extractor Checklist | Adding a new data source extractor |
| Extractor Testing Workflow | Testing extractors locally before deploying |
| Schemachange Deployment | Deploying Bronze DDL migrations |
| Snowflake S3 Stage Setup | Configuring a Snowflake external S3 stage |
| dbt Development Workflow | Writing, testing, and deploying dbt models |
| Gold Layer Expansion | Adding fct_, dim_, agg_, or rpt_ models |
| Merge Checklist | Pre-merge verification checklist |
| xo-foundry Roadmap | DAG factory roadmap and planned phases |
Writing a new guide¶
A guide belongs here when a procedure is repeated more than once. Write it the first time you do it — not after the third time someone asks how.
Structure every guide as: 1. Purpose — one sentence on what this achieves 2. Prerequisites — what must be in place before starting 3. Steps — numbered, imperative, include actual commands 4. Verification — how to confirm it worked 5. Troubleshooting — the two or three most common failure modes
Guides change when procedures change. Update the guide when you update the procedure — not six months later.