Skip to content

ARROW-13405: [Doc] Guide users to the documentation for their own platform #10767

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

Closed
amol- wants to merge 1 commit into from
Closed

ARROW-13405: [Doc] Guide users to the documentation for their own platform #10767

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,27 +32,15 @@ such topics as:
* Reading and writing file formats (like CSV, Apache ORC, and Apache Parquet)
* In-memory analytics and query processing

.. _toc.columnar:

.. toctree::
:maxdepth: 2
:caption: Specifications and Protocols

format/Versioning
format/Columnar
format/Flight
format/Integration
format/CDataInterface
format/CStreamInterface
format/Other
**To learn how to use Arrow refer to the documentation specific to your
target environment.**

.. _toc.usage:

.. toctree::
:maxdepth: 2
:caption: Libraries
:maxdepth: 1
:caption: Supported Environments
Copy link
Member Author

@amol- amol- Jul 21, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI regarding the change of this title.

I didn't feel that "Libraries" was the best word from a user point of view. I can see how they are different libraries implementing arrow, but from the user point of view "Arrow" is probably seen as one thing that supports multiple different target languages/platforms/environments.

I think that "Supported Platforms" was probably the one that involved the less cognitive load for a reader as that's usually the title you look for when interested in knowing if a software works on your system, but in the end I went for "Supported Environments" as Platforms seemed to convey too much an OS/Hardware meaning.

Copy link
Member

@pitrou pitrou Jul 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nealrichardson Thoughts?


status
C/GLib <https://arrow.apache.org/docs/c_glib/>
C++ <cpp/index>
C# <https://github.com/apache/arrow/blob/master/csharp/README.md>
Expand All @@ -65,6 +53,21 @@ such topics as:
R <https://arrow.apache.org/docs/r/>
Ruby <https://github.com/apache/arrow/blob/master/ruby/README.md>
Rust <https://docs.rs/crate/arrow/>
status
Copy link
Member

@pitrou pitrou Jul 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, but it seems better to me to put forward the status matrix, since it gives a synthetic view of what each library (or "supported environment") supports.

Copy link
Member Author

@amol- amol- Jul 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI, the reason why I moved it at the end is that the primary thing readers are probably going to look for is their own target language. So the Implementation comparison makes sense as an additional information but probably it's not the first thing you are looking for, you probably want to see "Python"/R so that you can quickly jump into the doc you are looking for. The comparison between platforms is probably going to come in a second time when you ask yourself why you can't do something on X while you could on Y or situations like that.

I don't have a strong opinion about this one, but I think it's helpful to keep it out of the list of supported platforms and moving it at the end was a quick way to get it out of the way of most readers apart from those explicitly looking for it.

Copy link
Member

@pitrou pitrou Jul 26, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sounds fair to me :-)


.. _toc.columnar:

.. toctree::
:maxdepth: 2
:caption: Specifications and Protocols

format/Versioning
format/Columnar
format/Flight
format/Integration
format/CDataInterface
format/CStreamInterface
format/Other

.. _toc.development:

Expand Down