You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2021/07/21 13:30:19 UTC
[GitHub] [arrow] amol- opened a new pull request #10767: Guide users to the documentation for their own platform
amol- opened a new pull request #10767:
URL: https://github.com/apache/arrow/pull/10767
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amol- commented on a change in pull request #10767: Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
amol- commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r673976246
##########
File path: docs/source/index.rst
##########
@@ -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
Review comment:
I don't think that "Libraries" is 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 on 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 known 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amol- commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
amol- commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r673976246
##########
File path: docs/source/index.rst
##########
@@ -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
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r674835322
##########
File path: docs/source/index.rst
##########
@@ -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
Review comment:
@nealrichardson Thoughts?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r674836691
##########
File path: docs/source/index.rst
##########
@@ -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
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#issuecomment-884197249
https://issues.apache.org/jira/browse/ARROW-13405
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
pitrou commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r676726647
##########
File path: docs/source/index.rst
##########
@@ -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
Review comment:
This sounds fair to me :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] pitrou closed pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
pitrou closed pull request #10767:
URL: https://github.com/apache/arrow/pull/10767
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] github-actions[bot] commented on pull request #10767: Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#issuecomment-884191655
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
Thanks for opening a pull request!
If this is not a [minor PR](https://github.com/apache/arrow/blob/master/CONTRIBUTING.md#Minor-Fixes). 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](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.) of the Apache Arrow project.
Then could you also rename pull request title in the following format?
ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
See also:
* [Other pull requests](https://github.com/apache/arrow/pulls/)
* [Contribution Guidelines - How to contribute patches](https://arrow.apache.org/docs/developers/contributing.html#how-to-contribute-patches)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amol- commented on a change in pull request #10767: Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
amol- commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r673976246
##########
File path: docs/source/index.rst
##########
@@ -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
Review 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 known 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow] amol- commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform
Posted by GitBox <gi...@apache.org>.
amol- commented on a change in pull request #10767:
URL: https://github.com/apache/arrow/pull/10767#discussion_r675433605
##########
File path: docs/source/index.rst
##########
@@ -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
Review 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org