apache / apache/arrow

[C++][Docs] Show examples of multiple Acero-compatible language APIs

Open
#32,477 0 comments 0 reactions 0 assignees View on GitHub
Component: C++ Component: Documentation Type: task
Dominant language
C++
Stars
17.1k
Forks
4.3k
Avg merge
3d 18h
Merged PRs (30d)
91

Description

Today, there is really only one feature-complete high-level API wrapping the lower-level Acero ExecPlan API: the dplyr interface arrow R pacakge. But in the future, when Acero has full capability to consume and execute Substrait plans, then will have more high-level APIs wrapping Acero, including Ibis. It would be nice to include a tabbed interface in a prominent place on the front page of the Acero docs showing several different Acero-compatible language APIs, similar to what's on the front page of the [Apache Spark website](https://spark.apache.org/). Credit to @wjones127  for suggesting this idea.

**Reporter**: [Ian Cook](https://issues.apache.org/jira/browse/ARROW-17182) / @ianmcook

**Note**: *This issue was originally created as [ARROW-17182](https://issues.apache.org/jira/browse/ARROW-17182). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Contributor guide

Open the contributing guide

Research direction

Start by locating the Acero documentation front page and reviewing how its current high-level API material is presented. Compare the requested tabbed presentation with the Apache Spark website example, then confirm that the front page shows examples for several Acero-compatible language APIs and remains prominent and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, r
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.