Skip to content

docs: mount lance-flink connector docs into the integrations site - #8987

Open
fightBoxing wants to merge 3 commits into
lance-format:mainfrom
fightBoxing:docs/flink-integration
Open

docs: mount lance-flink connector docs into the integrations site#8987
fightBoxing wants to merge 3 commits into
lance-format:mainfrom
fightBoxing:docs/flink-integration

Conversation

@fightBoxing

Copy link
Copy Markdown

Summary

Adds LANCE_FLINK_REPO to docs/make-full-website.sh so the lance-flink connector docs (docs/src/) are aggregated under integrations/flink, following the existing lance-spark / lance-trino / lance-context pattern.

Changes

  • New LANCE_FLINK_REPO env var (default $HOME/oss/lance-flink), documented in the usage block.
  • Resolve flink_repo via resolve_repo_dir.
  • Mount flink_repo/docs/srcdocs_src/integrations/flink and append Apache Flink: flink to the integrations nav.
  • Mount flink_repo/CONTRIBUTING.mdcommunity/project-specific/flink.md.

Note

The corresponding docs/src/ content lives in the lance-flink repository and is not part of this PR. The flink docs are still in progress; until the lance-flink docs/src/ is merged, the build keeps the placeholder and logs a warning (same behaviour as other missing repos).

Related: lance-format/lance-flink#63

Add LANCE_FLINK_REPO to make-full-website.sh so the lance-flink
connector docs (docs/src/) are aggregated under
integrations/flink, following the existing lance-spark /
lance-trino pattern.
@github-actions github-actions Bot added documentation Improvements or additions to documentation A-docs Documentation labels Sep 4, 2026
lance-gatekeeper[bot]

This comment was marked as outdated.

@lance-gatekeeper lance-gatekeeper Bot added the K-changes Latest Gatekeeper recommendation requests changes. label Sep 4, 2026
The flink docs mount added to make-full-website.sh needs the
lance-flink repo checked out and LANCE_FLINK_REPO wired into the
Assemble step, otherwise the build keeps the placeholder and logs a
missing-repo warning.
@github-actions github-actions Bot added the A-ci CI / build workflows label Sep 4, 2026
@lance-gatekeeper lance-gatekeeper Bot removed the K-changes Latest Gatekeeper recommendation requests changes. label Sep 4, 2026
lance-gatekeeper[bot]

This comment was marked as outdated.

@lance-gatekeeper lance-gatekeeper Bot added the K-changes Latest Gatekeeper recommendation requests changes. label Sep 4, 2026
Complete the integration pattern by cleaning the two generated Flink
paths (integrations/flink and project-specific/flink.md) so clean /
rollback does not retain stale outputs, matching lance-context.
@lance-gatekeeper lance-gatekeeper Bot removed the K-changes Latest Gatekeeper recommendation requests changes. label Sep 7, 2026

@lance-gatekeeper lance-gatekeeper Bot left a comment

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.

⚠️ Gate recommendation: approve with a non-blocking risk.

Both prior findings are fixed. The production workflow now supplies the Flink checkout, the assembled site builds against lance-flink#75, and cleanup removes both generated outputs.

The related docs PR is still open, and the Lance deploy runs only when changes are pushed to its main branch. If this PR merges first, Flink remains a placeholder until #75 lands and a later Lance deployment runs; merging #75 first or arranging a subsequent Lance docs deploy avoids that delay.

@lance-gatekeeper lance-gatekeeper Bot added K-approved Latest Gatekeeper recommendation permits acceptance. K-risk Latest Gatekeeper recommendation includes a non-blocking risk. labels Sep 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-ci CI / build workflows A-docs Documentation documentation Improvements or additions to documentation K-approved Latest Gatekeeper recommendation permits acceptance. K-risk Latest Gatekeeper recommendation includes a non-blocking risk.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant