[jira] [Comment Edited] (ARROW-17286) [C++][Docs] Add Getting Started Section

["Kae Suarez (Jira)" <ji...@apache.org>]

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

Kae Suarez edited comment on ARROW-17286 at 8/2/22 6:52 PM:
------------------------------------------------------------

[~zeroshade] Currently, we do already link to building from source for the current "using in your project" page, but the installing not from source doesn't even have a link – of course, we can just add one over the "using a package manager" text: [https://arrow.apache.org/docs/cpp/build_system.html]

I agree that we definitely need to include what to link against – right now, it isn't immediately clear things like libarrow_dataset is needed until you try to use it and fail – at least in CMake. All appears fine for pkg-config users, though there isn't a very good mapping of what is needed for what.

I'm not perfectly sure what you mean by bootstrapping – do you mean _only_ linking to the relevant articles, or writing a single example and also linking to those? I would prefer the latter, so we have parity with documentation for other Arrow libraries, and have a good starting point for people to understand what Arrow code looks like for a given pattern before moving into the denser, specific documentation.


was (Author: JIRAUSER293080):
[~zeroshade] Currently, we do already link to building from source for the current "using in your project" page, but the installing not from source doesn't even have a link – of course, we can just add one over the "using a package manager" text: [https://arrow.apache.org/docs/cpp/build_system.html]

I agree that we definitely need to include what to link against – right now, it isn't immediately clear things like libarrow_dataset is needed until you try to use it and fail.

I'm not perfectly sure what you mean by bootstrapping – do you mean _only_ linking to the relevant articles, or writing a single example and also linking to those? I would prefer the latter, so we have parity with documentation for other Arrow libraries, and have a good starting point for people to understand what Arrow code looks like for a given pattern before moving into the denser, specific documentation.

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