Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs][Format] Add an introductory page to the Arrow Columnar Format #41673

Closed
AlenkaF opened this issue May 15, 2024 · 1 comment
Closed

[Docs][Format] Add an introductory page to the Arrow Columnar Format #41673

AlenkaF opened this issue May 15, 2024 · 1 comment
Assignees
@AlenkaF
Labels
Component: Documentation Component: Format Type: enhancement
Milestone
18.0.0

Comments

@AlenkaF
Copy link
Member

AlenkaF commented May 15, 2024

Describe the enhancement requested

The documentation for Arrow Format could be improved with with a not too technical content that would serve as an introductory to the format spec. It would be worth having a separate page that would include:

  • content about the idea of the columnar format
  • different physical layouts explained together with diagrams of example type in comparison to the physical layout
  • main Arrow terminology (record batch, array, etc.)
  • Arrow C Data interface

Component(s)

Documentation, Format
@AlenkaF AlenkaF self-assigned this May 15, 2024
@github-actions github-actions bot mentioned this issue May 15, 2024
Merged
AlenkaF added a commit that referenced this issue Oct 1, 2024
@AlenkaF @raulcd
@jorisvandenbossche @felipecrv @paleolimbot @amoeba
GH-41673: [Format][Docs] Add arrow format introductory page (#41593)
fa6a003 
### Rationale for this change

The documentation for Arrow Format could be improved:

- all types are not listed
- all layouts are not explained

### What changes are included in this PR?

This PR includes:

- motivation behind the columnar format
- different physical layouts explained together with diagrams of example type in comparison to the physical layout
- Arrow terminology
- Extension types and sharing of Arrow data

in a separate "introduction" page with no technical details. Specifications index page is also restructured to include captions and make the left sidebar menu better organised.

**Note:** a table with all types listed together with their physical layout will be added in a separate PR to existing _Columnar.rst_ page: #14752

### Are these changes tested?

No, this is a docs change.

### Are there any user-facing changes?

No.

* GitHub Issue: #41673

Lead-authored-by: AlenkaF <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Alenka Frim <alenkafrim@Alenkas-MacBook-Pro.local>
Co-authored-by: Raúl Cumplido <raulcumplido@gmail.com>
Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
Co-authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com>
Co-authored-by: Dewey Dunnington <dewey@dunnington.ca>
Co-authored-by: Bryce Mecum <petridish@gmail.com>
Signed-off-by: AlenkaF <frim.alenka@gmail.com>
@AlenkaF
Copy link
Member Author

AlenkaF commented Oct 1, 2024

Issue resolved by pull request 41593
#41593

@AlenkaF AlenkaF added this to the 18.0.0 milestone Oct 1, 2024
@AlenkaF AlenkaF closed this as completed Oct 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AlenkaF AlenkaF

Labels
Component: Documentation Component: Format Type: enhancement
Projects
None yet
Milestone
18.0.0
Development

No branches or pull requests
1 participant
@AlenkaF