[ 
https://issues.apache.org/jira/browse/ARROW-17286?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17574360#comment-17574360
 ] 

Matthew Topol commented on ARROW-17286:
---------------------------------------

[~ksuarez] I assume we're not going to need a section on actually installing 
the Arrow libraries / building them from source as those are already covered 
elsewhere in the documentation? A section that just points to those relevant 
portions of the documentation might still be useful for anyone Getting Started 
as far as setting up their development environment so they can link against the 
Arrow libraries.

I think another reasonable thing we should cover in this Getting Started 
section might be a breakdown of the different dynamic libraries that are 
installed/built by Arrow so that a user knows which ones they should link 
against and why (or at least know what they should pass to `pkg-config` when 
getting their compile/link flags). While we might be explicit in any tutorial 
sections about what to link against (adding in 
libarrow_dataset/libarrow_flight/etc as necessary) it would still be helpful to 
have just a flat breakdown of what is in which .so file.

After that, bootstrapping with handling "Getting Data Into Arrow" - links to 
docs on reading CSV/parquet/<insert format here> files including links to the 
Dataset libraries. followed by "ways to process arrow data" -links to the 
compute libraries and other cookbook examples.

Thoughts?

> [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)

Reply via email to