Skip to content

docs: add lance-flink connector documentation site - #75

Merged
fightBoxing merged 1 commit into
lance-format:mainfrom
fightBoxing:main
Sep 22, 2026
Merged

fightBoxing merged 1 commit into
lance-format:mainfrom
fightBoxing:main

Conversation

@fightBoxing

Copy link
Copy Markdown
Collaborator

Summary

Adds docs/src/ to the lance-flink repository, following the lance-spark docs template, so the connector can be aggregated into the lance.org integrations site (see lance-format/lance#8987).

Structure

docs/src/
├── .pages                    # Welcome → Install → Config → Performance → Operations
├── index.md                  # Introduction / Features / Quick Start
├── install.md                # 1.18/1.19/1.20, deps, JNI platforms, build
├── config.md                 # full ConfigOption reference (read/write/index/vector/S3/hadoop.*/namespace)
├── performance.md            # index selection, search tuning, write amplification
└── operations/
    ├── ddl/    create-catalog.md + create-table.md
    ├── dql/    select.md + vector-search.md + time-travel.md
    └── dml/    insert-into.md

Notes

Related: lance-format/lance#8987

Add docs/src/ following the lance-spark docs template, covering:
- Welcome, Install, Config, Performance
- Operations: DDL (create-catalog, create-table), DQL (select,
  vector-search, time-travel), DML (insert-into)

Unimplemented capabilities (ALTER TABLE, CREATE INDEX, UPDATE, DELETE)
are explicitly noted as unsupported / in progress.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 4, 2026
@fightBoxing
fightBoxing merged commit 6230e62 into lance-format:main Sep 22, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant