Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fightBoxing wants to merge 3 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
447935e
docs: mount lance-flink docs into integrations site
Sep 4, 2026
91cc931
docs: checkout lance-flink repo in docs-deploy workflow
Sep 4, 2026
55a6f7a
docs: add flink removals to clean-full-website.sh
Sep 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/workflows/docs-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ jobs:
with:
repository: lance-format/lance-context
path: lance-context
- name: Checkout lance-flink
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4
with:
repository: lance-format/lance-flink
path: lance-flink
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
Expand All @@ -89,6 +94,7 @@ jobs:
LANCE_DUCKDB_REPO: ${{ github.workspace }}/lance-duckdb
LANCE_HUGGINGFACE_REPO: ${{ github.workspace }}/lance-huggingface
LANCE_CONTEXT_REPO: ${{ github.workspace }}/lance-context
LANCE_FLINK_REPO: ${{ github.workspace }}/lance-flink
run: |
docs/make-full-website.sh
- name: Deploy
Expand Down
2 changes: 2 additions & 0 deletions docs/clean-full-website.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ rm -rf "$docs_src/integrations/spark"
rm -rf "$docs_src/integrations/ray"
rm -rf "$docs_src/integrations/trino"
rm -rf "$docs_src/integrations/context"
rm -rf "$docs_src/integrations/flink"
rm -f "$docs_src/community/project-specific/.pages"
rm -rf "$docs_src/community/project-specific/lance"
rm -f "$docs_src/community/project-specific/namespace.md"
Expand All @@ -24,6 +25,7 @@ rm -f "$docs_src/community/project-specific/ray.md"
rm -f "$docs_src/community/project-specific/spark.md"
rm -f "$docs_src/community/project-specific/trino.md"
rm -f "$docs_src/community/project-specific/context.md"
rm -f "$docs_src/community/project-specific/flink.md"

cat > "$docs_src/format/.pages" <<'EOF'
nav:
Expand Down
14 changes: 14 additions & 0 deletions docs/make-full-website.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Override any repo path with the matching environment variable:
LANCE_DUCKDB_REPO
LANCE_HUGGINGFACE_REPO
LANCE_CONTEXT_REPO
LANCE_FLINK_REPO
Defaults:
LANCE_NAMESPACE_REPO=$HOME/oss/lance-namespace
LANCE_NAMESPACE_IMPLS_REPO=$HOME/oss/lance-namespace-impls
Expand All @@ -23,6 +24,7 @@ Defaults:
LANCE_DUCKDB_REPO=$HOME/oss/lance-duckdb
LANCE_HUGGINGFACE_REPO=$HOME/oss/lance-huggingface
LANCE_CONTEXT_REPO=$HOME/oss/lance-context
LANCE_FLINK_REPO=$HOME/oss/lance-flink
EOF
}

Expand Down Expand Up @@ -63,6 +65,7 @@ trino_repo_input=${LANCE_TRINO_REPO:-$HOME/oss/lance-trino}
duckdb_repo_input=${LANCE_DUCKDB_REPO:-$HOME/oss/lance-duckdb}
huggingface_repo_input=${LANCE_HUGGINGFACE_REPO:-$HOME/oss/lance-huggingface}
context_repo_input=${LANCE_CONTEXT_REPO:-$HOME/oss/lance-context}
flink_repo_input=${LANCE_FLINK_REPO:-$HOME/oss/lance-flink}

copy_docs_dir() {
local source_dir="$1"
Expand Down Expand Up @@ -138,6 +141,7 @@ trino_repo=$(resolve_repo_dir "$trino_repo_input")
duckdb_repo=$(resolve_repo_dir "$duckdb_repo_input")
huggingface_repo=$(resolve_repo_dir "$huggingface_repo_input")
context_repo=$(resolve_repo_dir "$context_repo_input")
flink_repo=$(resolve_repo_dir "$flink_repo_input")

"$script_dir/clean-full-website.sh"

Expand Down Expand Up @@ -275,6 +279,12 @@ else
warn_missing_repo "Lance Context docs" "$context_repo/docs/src"
fi

if copy_docs_dir "$flink_repo/docs/src" "$docs_src/integrations/flink"; then

@lance-gatekeeper lance-gatekeeper Bot Sep 4, 2026

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.

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.

@lance-gatekeeper lance-gatekeeper Bot Sep 4, 2026

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.

Fixed in 91cc931: the deploy workflow now checks out lance-format/lance-flink and exports LANCE_FLINK_REPO to the assembly step.

integration_entries+=(" - Apache Flink: flink")
else
warn_missing_repo "Lance Flink docs" "$flink_repo/docs/src"
fi

{
echo "nav:"
for entry in "${integration_entries[@]}"; do
Expand Down Expand Up @@ -319,6 +329,10 @@ if copy_file_if_exists "$context_repo/CONTRIBUTING.md" "$docs_src/community/proj
project_entries+=(" - Lance Context: context.md")
fi

if copy_file_if_exists "$flink_repo/CONTRIBUTING.md" "$docs_src/community/project-specific/flink.md"; then

@lance-gatekeeper lance-gatekeeper Bot Sep 4, 2026

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.

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.md

The final assertion exits 1; both paths are still present.

@lance-gatekeeper lance-gatekeeper Bot Sep 7, 2026

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.

Fixed in 55a6f7a: clean-full-website.sh now removes both generated Flink paths; assembling against the lance-flink#75 docs head and then cleaning leaves both paths absent.

project_entries+=(" - Lance Flink: flink.md")
fi

{
echo "nav:"
for entry in "${project_entries[@]}"; do
Expand Down
Loading