Skip to content

docs: add Hosted Sinks documentation#804

Merged
maoueh merged 2 commits into
developfrom
docs/hosted-sinks
Jun 16, 2026
Merged

docs: add Hosted Sinks documentation#804
maoueh merged 2 commits into
developfrom
docs/hosted-sinks

Conversation

@joshkauffman

Copy link
Copy Markdown
Contributor

Summary

  • Add how-to-guides/sinks/hosted-sinks/hosted-sinks.md — overview and step-by-step creation guide (package source options, Postgres/ClickHouse output config, execution config)
  • Add how-to-guides/sinks/hosted-sinks/manage-your-sink.md — monitoring, status reference, and lifecycle management (edit, stop, reset, delete)
  • Update SUMMARY.md to include both new pages under Consuming Substreams
  • Update sinks.md to surface Hosted Sinks at the top of the sinks list

Notes for reviewers

Two items to verify before merging:

  1. The Graph Market portal URL — used https://thegraph.market as placeholder, confirm the correct URL
  2. Reset behavior — inferred from restart_from_scratch proto field; confirm whether UI exposes drop-schema vs. truncate-tables as distinct options

Test plan

  • Verify portal URL is correct
  • Verify reset/restart-from-scratch behavior description matches UI
  • Confirm all cross-links resolve in GitBook (SQL sink, Sink Config reference)

Add two-page guide for the Hosted Sinks managed service on The Graph Market:
- Overview and step-by-step creation (package source, output config, execution config)
- Monitoring and lifecycle management (status reference, edit, stop, reset, delete)

Update SUMMARY.md and sinks.md to surface Hosted Sinks at the top of the sinks section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@sduchesneau

sduchesneau commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

🔍 Vulnerabilities of ghcr.io/streamingfast/substreams:95a643a

📦 Image Reference ghcr.io/streamingfast/substreams:95a643a
digestsha256:c5806e7133b223db9ca2ee0f74f0282568aa42154f413ed499868a624830bbe1
vulnerabilitiescritical: 0 high: 0 medium: 0 low: 0
platformlinux/amd64
size111 MB
packages353
📦 Base Image ubuntu:24.04
also known as
  • c136481b8f4cd58cb213a22ee358ea1047bc963a338c61cdccb518e233409f86
  • noble
  • noble-20260509.1
digestsha256:023f8a753c22258c9fe2d0005a7d28258038da7d620e9f93e9ad78aa266f9f11
vulnerabilitiescritical: 0 high: 1 medium: 25 low: 11


## Creating a Sink

Navigate to **Sinks** in the sidebar and click **New Sink**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshots or at very least URLs are needed.

| Source | When to use |
|---|---|
| **URL** | The package is hosted at a public URL (e.g., GitHub releases, IPFS). |
| **Substreams.dev** | The package is published on The Graph Market. Enter its ID (e.g., `mainnet.eth.v0.1.0`). |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Example id is wrong, and it's not publish on The Graph Market.


Navigate to **Sinks** and click a sink to open its detail page. The page has three main sections: the runtime summary, the pod list, and the deployment event log.

### Runtime Summary

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here, screenshots or URLs minimally

- Link "Sinks" to https://thegraph.market/sinks
- Add add-sinks-graph-market.png after the navigation step
- Change "The Graph Market" to "the Substreams Registry" linking https://substreams.dev
- Update example package ID to ethereum_common@v0.3.3
- Add sink-details-graph-market.png to the sink detail page section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@maoueh maoueh merged commit 54f589c into develop Jun 16, 2026
8 checks passed
@maoueh maoueh deleted the docs/hosted-sinks branch June 16, 2026 20:58
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.

3 participants