Skip to content

Commit

Permalink
docs: Initial 5.0 docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ibgreen committed Oct 4, 2024
1 parent fd657d5 commit cb29bef
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Upgrade Guide

## Upgrading to v5.0 (In development)

loaders.gl v5 is a major re-imagination of the library the optimizes loaders.gl for big cloud-native, binary data.

- **Apache Arrow** - When possible, loaders now return binary data in the Apache Arrow format. This aligns with parallel efforts in companion libraries like deck.gl to work with zero-copy, compact binary data instead of bloated, deserialized javascript data structures, resulting in up to an order of magnitude better loading and processing performance on big data.

- **Single output format per loader** - The `shape` option that was introduced in loaders.gl v3 to allow loaders to return
different data formats is now deprecated and removed in many places.
Instead, applications can use utilities in the `@loaders.gl/schema-utils` and `@loaders.gl/gis` modules to
convert for Apache Arrow and Apache GeoArrow to more traditional JavaScript formats.

- **Improved `DataSource` API** -



## Upgrading to v4.3 (In development)

**Breaking Changes**
Expand Down
13 changes: 12 additions & 1 deletion docs/whats-new.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
# What's New

## v5.0 (in early development)

Target Release Date: Q1 2025

loaders.gl v5 is going to be a re-imagined library that now focuses on cloud-native, binary data.
When possible, loaders now return binary data in the Apache Arrow and Apache GeoArrow formats.

While no loader support has been removed, the flavor of the library has changed significantly.

Please consult the upgrade guide for information on breaking changes.

## v4.3 (in development)

Target Release Date: June 2024
Target Release Date: Dec 2024

A minor release that includes:

Expand Down

0 comments on commit cb29bef

Please sign in to comment.