Skip to content

docs(destinations): add 11 warehouse/storage/queue destination pages (ENG-4130) - #695

Merged
RajatPawar merged 12 commits into
mainfrom
rajatspawar/eng-4130-sinks
Aug 18, 2026
Merged

docs(destinations): add 11 warehouse/storage/queue destination pages (ENG-4130)#695
RajatPawar merged 12 commits into
mainfrom
rajatspawar/eng-4130-sinks

Conversation

@RajatPawar

Copy link
Copy Markdown
Contributor

Documents the 11 new Svix stream-sink destination types shipped in server#7057 / openapi#394.

New pages (src/destinations/)

Data warehouses: clickhouse, snowflake, bigquery, redshift
Object storage: azure-blob, gcs
Message queues / event buses: sqs, sns, eventbridge, pubsub, rabbitmq

Each page follows the existing Kinesis / S3 destination page structure — intro, prerequisites, a config-field table matching the dashboard fields, an amp.yaml reference example, and a message-format section linking to the canonical read/subscribe payload schema.

Other changes

  • Registered the new pages in src/generate-docs.ts and regenerated src/docs.json.
  • Updated destinations/overview — moved the newly-supported types out of the roadmap into a grouped "Supported destinations" list.

…(ENG-4130)

Add pages for ClickHouse, Snowflake, BigQuery, Redshift, Azure Blob Storage,
Google Cloud Storage, Amazon SQS, Amazon SNS, Amazon EventBridge, Google Cloud
Pub/Sub, and RabbitMQ, modeled after the existing Kinesis/S3 destination pages.
Register them in generate-docs.ts (regenerated docs.json) and update the
destinations overview.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 17, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Ampersand 🟢 Ready View Preview Aug 17, 2026, 7:16 PM

@linear

linear Bot commented Aug 17, 2026

Copy link
Copy Markdown

ENG-4130

ENG-4200

…tions (ENG-4130)

Warehouse pages now document the exact table the sink expects (BigQuery id/payload;
Snowflake id/created_at/payload; Redshift created_at/payload; ClickHouse one column
per top-level field) plus the optional batchSize/maxWaitSecs. Overview adds a
"Considerations" section: pre-created warehouse tables, batching, the 10-per-project
sink limit, and the GCS/Azure object-naming caveat.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Merge table-setup + message-format into a "Data format" section placed before
  "Refer to the destination", linking to webhook.yaml for the payload schema.
- Warehouses show the table they need: ClickHouse maps top-level keys to columns
  (example with ...); BigQuery/Snowflake/Redshift load the payload into a single
  column (id/created_at/payload as applicable).
- Add an Example column to every "Create a destination" table.
- Remove em dashes, remove "we store credentials securely" notes, and remove all
  vendor (Svix) references.
- Alphabetize the Destinations sidebar; drop the overview "Considerations" section.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…-4130)

- Remove "read fields with X's JSON functions" guidance from BigQuery, Snowflake,
  and Redshift; the pages describe only the table shape Ampersand writes to.
- Remove the "Ampersand encrypts and stores your credentials securely" notes from
  the S3 and Kinesis pages.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment thread src/destinations/redshift.mdx Outdated
Nest the Destinations sidebar into Queues (EventBridge, Kinesis, Pub/Sub,
RabbitMQ, SNS, SQS), Databases and warehouses (BigQuery, ClickHouse, Redshift,
Snowflake), and Blob storage (Azure Blob, GCS, S3). Overview and Webhooks stay
top-level.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Blob-storage sinks write objects with an uncontrolled `object-generated-by-svix`
prefix, so hold them back until we own the naming. Remove the azure-blob and gcs
pages and their sidebar entries; S3 stays under "Blob storage". See Linear ENG-4200.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…200)

Remove the Object storage section (Azure Blob + GCS) and the prose mentions from
the destinations overview so the broken-links check passes. See Linear ENG-4200.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment thread src/docs.json
RajatPawar and others added 2 commits August 18, 2026 16:14
… note

- Remove the duplicate destinations/kinesis from the Queues group (it's a
  top-level destination, matching the overview); regenerate docs.json.
- Redshift: mark Workgroup name / Cluster identifier as No* and clarify the note
  that exactly one is required (addresses Graphite review comment).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…egories

Top-level overview/webhooks/slack, followed by the categories alphabetically
(Blob storage, Databases and warehouses, Queues). Kinesis moves into Queues.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Keep only Webhook and Slack at the top level; move Amazon S3 under a Blob storage
heading and Amazon Kinesis into Message queues and event buses, matching the
sidebar structure.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Comment thread src/destinations/overview.mdx Outdated
@RajatPawar
RajatPawar enabled auto-merge (squash) August 18, 2026 23:27
@RajatPawar
RajatPawar merged commit 0a455a4 into main Aug 18, 2026
3 checks passed
@RajatPawar
RajatPawar deleted the rajatspawar/eng-4130-sinks branch August 18, 2026 23:27
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