ARROW-13405: [Doc] Guide users to the documentation for their own platform #10767
Conversation
|
Thanks for opening a pull request! If this is not a minor PR. Could you open an issue for this pull request on JIRA? https://issues.apache.org/jira/browse/ARROW Opening JIRAs ahead of time contributes to the Openness of the Apache Arrow project. Then could you also rename pull request title in the following format? or See also: |
| :maxdepth: 2 | ||
| :caption: Libraries | ||
| :maxdepth: 1 | ||
| :caption: Supported Environments |
There was a problem hiding this comment.
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.
amol-
changed the title
| 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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
2 participants
No description provided.