Skip to content

[DOC] Restructure documentation to highlight Streaming Lakehouse deployment and core features #2358

@luoyuxia

Description

@luoyuxia

Search before asking

  • I searched in the issues and found nothing similar.

Description

Currently, the Lakehouse-related documentation is deeply nested, and core features like Union Read are scattered across different sections. This makes it difficult for users to understand how to set up and use Fluss as a Streaming Lakehouse.

We need to reorganize the documentation structure to provide a clear, step-by-step guide for Lakehouse deployment and consolidate core concept introductions.

Proposed Changes

  1. Reorganize "Installation & Deployment"
Installation & Deployment
  +-- Overview
  +-- Deploying Fluss Cluster
     +-- Deploying Local Cluster
     +-- Deploying Distributed Cluster
     +-- Deploying with Docker
     +-- Deploying with Helm Charts
  +-- Deploying Streaming Lakehouse

Add a new page for Deploying Streaming Lakehouse, it should cover:

  1. Introduce "Streaming Lakehouse" Core Concepts
    Add a top-level or significant section to explain the mechanics and supported integrations.
  • Lakehouse Overview
  • Tiering Service (Detailed explanation of the component), we can refer to the https://fluss.apache.org/blog/tiering-service/
  • Union Read (Core feature introduction)
  • Data Lakes (Ecosystem integration)
    • Iceberg
    • Paimon
    • Lance
Streaming Lakehouse
  +-- Lakehouse Overview
  +-- Tiering Service
  +-- Union Read
  +-- DataLake Formats
      +-- Iceberg
      +-- Paimon
      +-- Lance
  +-- DataLake Catalogs
  1. Refine "Maintenance" Section
  • Tiered Storage > Lakehouse Storage: Since deployment tutorials will move to the "Deploying" page, this section should be slimmed down. It should focus on component internals and configuration parameters rather than "how-to" steps.

  • Filesystems: Move this under Tiered Storage, as Filesystems are primarily used for remote storage abstraction.

Willingness to contribute

  • I'm willing to submit a PR!

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions