[
https://issues.apache.org/jira/browse/ARROW-17286?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17574363#comment-17574363
]
Will Jones commented on ARROW-17286:
------------------------------------
It might also be helpful to state what's out-of-scope for Getting Started. For
example, IIUC we want to leave conceptual info (What is a datatype, array,
compute kernel, etc.) for User Guide sections.
Let's please move to a Google doc so we can develop an outline.
Below is by initial idea of an outline (but you probably have better ideas),
which is broken up roughly by sub-library:
# Getting Started
## How to install Arrow
### Using system package managers (homebrew, apt, yum, etc)
### Using project package managers (vcpkg, conan, etc.)
### CMake External project
## Getting started with Arrow
### A simple example with an array and calling compute function
### Which headers to use
### How to link to libarrow
### Using ARROW_ASSIGN_OR_RAISE, Status, Result, and friends
### Links to other sections about contents of libarrow: DataTypes, Arrays, so
on
## Getting started with Parquet
### A simple example loading parquet data without Arrow (that's possible,
right?)
### A simple example loading parquet data into Arrow
### Which headers + how to link (with and without Arrow, if possible)
## Getting started with Datasets
### A simple example
### Headers + libraries to include
### Links to further reading about datasets
## Getting started with Acero
### A simple example of building an exec plan
### Headers + libraries to include
### Links to further reading about Acero
## Using Flight in your project
### A minimal flight sever
### Headers + libraries to include, with special notes about gRPC + Abseil
linking
### Links to further reading on Flight
> [C++][Docs] Add Getting Started Section
> ---------------------------------------
>
> Key: ARROW-17286
> URL: https://issues.apache.org/jira/browse/ARROW-17286
> Project: Apache Arrow
> Issue Type: Sub-task
> Reporter: Kae Suarez
> Priority: Major
>
> The C++ library documentation currently needs to be more focused in each of
> its sections, and currently does not have enough sections to accomplish that.
> Furthermore, the new user experience is difficult, partially due to not
> having an intro tutorial for the C++ library.
> Thus, there needs to be the addition of a "Getting Started" section to the
> C++ library documentation to enable new users to flourish, and the
> documentation as a whole to evolve further.
> It is necessary to first determine what are fitting topics for this section,
> then implement them.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
