Skip to content

[WIP] Add Hex integration documentation#37960

Draft
kevinzenghu wants to merge 2 commits into
masterfrom
kevinzenghu/add-hex-integration-docs
Draft

[WIP] Add Hex integration documentation#37960
kevinzenghu wants to merge 2 commits into
masterfrom
kevinzenghu/add-hex-integration-docs

Conversation

@kevinzenghu

Copy link
Copy Markdown
Contributor

Summary

  • Hex is GA per the DO Product Features tracker, but had zero public documentation.
  • Adds a page following the existing Metabase/Looker/PowerBI structure, plus a link from the Business Intelligence index.

Evidence

  • Crawler: data-observability-crawler/internal/crawlers/hex/ (hex_client.go, hex_crawler.go, models.go) — auth method, discovered entities, sync interval.
  • Connection schema: hex.json — exact field names/descriptions for the integration tile.

Open items

  • Confirm current phase (GA) with DO PM before merging.
  • Databricks/Postgres lineage limitation (noted in the doc) should be reviewed — confirm it's still accurate before merging, since this is exactly the kind of thing that can ship between when I checked the code and when this merges.
  • No screenshot included — this integration doesn't have a distinct UI flow beyond the standard integration tile, so likely low priority, but flagging per the pipeline's screenshot policy.

Status

Work in progress — not ready for review yet. Draft, no reviewers requested.

AI assistance

Content drafted by Claude Code, grounded in the cited crawler source and connection schema — flagging per the AI-assistance disclosure in CONTRIBUTING.md.

Hex has been GA (per the DO Product Features tracker) with zero public
documentation. Grounded in domains/data_observability/apps/apis/
data-observability-crawler/internal/crawlers/hex/ (hex_client.go,
hex_crawler.go, models.go) and the hex.json connection schema.

Follows the same structure as the sibling Metabase/Looker/PowerBI pages.
Explicitly notes the one real limitation found in code: Databricks and
Postgres data-connection lineage is incomplete (TODO comments in
models.go) even though Snowflake and BigQuery are fully supported —
included so the docs don't overclaim.

AI assistance: drafted by Claude Code, grounded in the cited crawler
source and connection schema.
@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Same class of bug just found and fixed for Airbyte: this PR's new
content/en/.../business_intelligence/hex.md page and its elt-equivalent
whatsnext link were correctly added, but config/_default/menus/main.en.yaml
(the separate file that drives the actual sidebar) was not — this branch
predates discovering that file exists. Added the missing entry, weighted
to sort after the existing four BI integrations.
@github-actions github-actions Bot added the Architecture Everything related to the Doc backend label Jul 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant