[
https://issues.apache.org/jira/browse/ARROW-17286?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17574351#comment-17574351
]
Kae Suarez commented on ARROW-17286:
------------------------------------
Before just writing code + prose, we need to figure out what sort of sections
should be in a preliminary implementation. Coming from the Python docs, it
appears we at least need how to install Arrow, then how to initialize data
structures by hand and from files, how to do computations, and how to work with
large data. However, the Python Getting Started is a bit terse, and we can
afford to be more verbose to have a stronger tutorial experience.
In these comments, I'd like to discuss what a potential Getting Started ToC
would look like, and we can definitely move to a different platform like Google
Docs if that would be more useful.
Furthermore, [~octalene] had this comment yesterday on the parent issue:
I think a getting started section sounds great.
In my mind, it would be a nice place to put sub-sections such as:
* "getting data into Arrow"
* "ways to process Arrow data"
I think as sub-sections these could introduce some concepts, how they relate,
and point to places in the docs that describe them in more detail. IMO, a nice
"getting started" also helps bootstrap enough knowledge to navigate the docs.
> [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)
