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/23 09:33:47 UTC

[GitHub] [arrow] amol- commented on a change in pull request #10767: ARROW-13405: [Doc] Guide users to the documentation for their own platform

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