Add a README for every example and standardize on the Estuary name#39
Open
danthelion wants to merge 2 commits into
Open
Add a README for every example and standardize on the Estuary name#39danthelion wants to merge 2 commits into
danthelion wants to merge 2 commits into
Conversation
Write or rewrite a technical, SEO-oriented README.md for all 29 example projects plus the four Python derivation subprojects, and rebuild the root README as a categorized index linking every example. Standardize the product name as "Estuary" throughout (no "Estuary Flow"/"Flow"). Each README documents the architecture in Estuary terms (capture -> collection -> materialization/derivation), what's included, prerequisites, copy-pasteable setup, and how to configure the capture/materialization via the dashboard or flowctl, with links to the relevant connector docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- dekaf-kcat: point consume.sh at the live Dekaf host (dekaf.fly.dev was retired) - postgres-cloudsql: add sqlalchemy and python-dotenv (imported by datagen.py) - streaming-lakehouse: add python-dotenv (imported by main.py) - shipments-stateful derivation: match the generator's "Out For Delivery" status casing - shipments_eta: pass MongoDB env vars through docker-compose instead of dead localhost/mongo defaults - shipments_eta: eta.sql uses arrayStringConcat on the flattened delays__reason column Sync the affected READMEs to the corrected behavior. Co-Authored-By: Claude Opus 4.8 <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
Adds or rewrites a technical
README.mdfor every example in the repo and rebuilds the rootREADME.mdas a categorized index. Also standardizes the product name as Estuary throughout (no "Estuary Flow" / bare "Flow").Two commits:
docs: add and refresh README for every example— documentation only.fix: correct latent bugs in example projects— small code fixes surfaced while writing the docs, plus README sync.READMEs
dekaf-python,estuary-demo-movies,mongodb-tinybird-clickstream,pyiceberg-aws-glue,python-derivations, andshipments-{ai,joins,stateless}.sqlserver-cdc-capture,oracle-capture,kafka-capture,shipments-datagen, theshipments-statefulMermaid diagram, the hands-on-lab steps).flowctl, with links to the relevant connector docs. Values (ports, users, tables, connector names) were verified against the actualdocker-compose,init.sql,flow.yaml, anddatagenfiles.Naming
All platform references now say Estuary.
flowctl,flow.yaml/.flow.py, andflow_capture/flow_publication/flow_watermarksidentifiers are left untouched.Fixes (commit 2)
dekaf-kcatconsume.shbootstrap hostdekaf.fly.dev:9092(retired) →dekaf.estuary-data.com:9092postgres-cloudsql-simple-capturedatagen/requirements.txtmissingSQLAlchemy+python-dotenv(imported bydatagen.py)streaming-lakehouse-iceberg-duckdbrequirements.txtmissingpython-dotenv(imported bymain.py)python-derivations/shipments-stateful'Out for Delivery'; generator emits'Out For Delivery'(status never matched)shipments_etadocker-compose.ymlhardcoded deadlocalhost/mongovalues → pass MongoDB env vars throughshipments_etaeta.sqlarrayJoin(s.delays_reason, …)→arrayStringConcat(s.delays__reason, …)(matches the Data Source column)Left as-is (flag for review)
shipments_eta/datagen/datagen.pyandtinybird/shipments.datasourcestill contain personal-looking values (dani2, a specific Atlas cluster host,KAFKA_CONNECTION_NAME 'Estuary Flow', theDani/shipments-demoprefix). Left untouched since they're functional config; happy to scrub them in a follow-up if desired.