docs: mount lance-flink connector docs into the integrations site - #8987
docs: mount lance-flink connector docs into the integrations site#8987fightBoxing wants to merge 2 commits into
Conversation
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
Bot
added
documentation
![lance-gatekeeper[bot]](https://avatars.githubusercontent.com/in/4433141?s=60&v=4){kind=small}
There was a problem hiding this comment.
❌ Gate recommendation: request changes.
The site assembly needs the same end-to-end ownership as the existing external integrations: make the Flink checkout available in production and include every generated Flink path in clean/rollback. The current script-only wiring leaves production unchanged and can retain stale local outputs.
A viable revision is to extend docs-deploy.yml, make-full-website.sh, and clean-full-website.sh together, following the existing lance-context pattern.
| warn_missing_repo "Lance Context docs" "$context_repo/docs/src" | ||
| fi | ||
|
|
||
| if copy_docs_dir "$flink_repo/docs/src" "$docs_src/integrations/flink"; then |
There was a problem hiding this comment.
The production deploy never makes this source path available: .github/workflows/docs-deploy.yml neither checks out lance-format/lance-flink nor exports LANCE_FLINK_REPO. On a fresh hosted runner the fallback $HOME/oss/lance-flink is absent, so this branch only warns and the deployed site omits Flink. Please add the checkout and env wiring alongside the existing Context/Trino entries.
rg -n 'lance-flink|LANCE_FLINK_REPO' .github/workflows/docs-deploy.yml returned no matches on this head.
There was a problem hiding this comment.
Fixed in 91cc931: the deploy workflow now checks out lance-format/lance-flink and exports LANCE_FLINK_REPO to the assembly step.
| project_entries+=(" - Lance Context: context.md") | ||
| fi | ||
|
|
||
| if copy_file_if_exists "$flink_repo/CONTRIBUTING.md" "$docs_src/community/project-specific/flink.md"; then |
There was a problem hiding this comment.
The two new generated outputs are not removed by docs/clean-full-website.sh. In a detached checkout I assembled with a temporary Flink repo and then ran the clean script; both docs/src/integrations/flink and docs/src/community/project-specific/flink.md remained. A subsequent assembly with a missing LANCE_FLINK_REPO removed their nav entries but still left those stale files. Add matching removals for both outputs so clean and missing-source rollback remain symmetric.
Reproducer run against this head
fixture=$(mktemp -d)
mkdir -p "$fixture/docs/src"
cp README.md "$fixture/docs/src/index.md"
cp CONTRIBUTING.md "$fixture/CONTRIBUTING.md"
LANCE_FLINK_REPO="$fixture" docs/make-full-website.sh
docs/clean-full-website.sh
test ! -e docs/src/integrations/flink &&
test ! -e docs/src/community/project-specific/flink.mdThe final assertion exits 1; both paths are still present.
lance-gatekeeper
Bot
added
the
K-changes
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.
lance-gatekeeper
Bot
removed
the
K-changes
There was a problem hiding this comment.
❌ Gate recommendation: request changes.
1 fixed / 1 remains. The deployment now checks out and wires lance-flink, so production can reach the source repository. The clean/rollback boundary still omits both generated Flink paths, leaving stale files after clean or a missing-source rerun.
Complete the established integration pattern by adding the two corresponding removals to docs/clean-full-website.sh.
lance-gatekeeper
Bot
added
the
K-changes
1 participant
Summary
Adds
LANCE_FLINK_REPOtodocs/make-full-website.shso the lance-flink connector docs (docs/src/) are aggregated underintegrations/flink, following the existinglance-spark/lance-trino/lance-contextpattern.Changes
LANCE_FLINK_REPOenv var (default$HOME/oss/lance-flink), documented in the usage block.flink_repoviaresolve_repo_dir.flink_repo/docs/src→docs_src/integrations/flinkand appendApache Flink: flinkto the integrations nav.flink_repo/CONTRIBUTING.md→community/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-flinkdocs/src/is merged, the build keeps the placeholder and logs a warning (same behaviour as other missing repos).Related: lance-format/lance-flink#63