ARROW-17270: [Docs] Move nightly package instructions to dev docs (#1…

…3766) ASF policies state we shouldn't direct people to unofficial/developer/nightly releases. Move the instructions to the developer documentation to make this clearer. Authored-by: David Li <li.davidm96@gmail.com> Signed-off-by: Sutou Kouhei <kou@clear-code.com>
apache · Aug 2, 2022 · 48e2780 · 48e2780
1 parent e80981c
commit 48e2780
Show file tree

Hide file tree

Showing 4 changed files with 185 additions and 183 deletions.
diff --git a/docs/source/developers/java/building.rst b/docs/source/developers/java/building.rst
@@ -220,3 +220,160 @@ Common Errors
 .. _Archery: https://github.com/apache/arrow/blob/master/dev/archery/README.md
 .. _Dependency Resolution: https://arrow.apache.org/docs/developers/cpp/building.html#individual-dependency-resolution
 .. _C++ shared libraries: https://arrow.apache.org/docs/cpp/build_system.html
+
+
+Installing Nightly Packages
+===========================
+
+.. warning::
+    These packages are not official releases. Use them at your own risk.
+
+Arrow nightly builds are posted on the mailing list at `builds@arrow.apache.org`_.
+The artifacts are uploaded to GitHub. For example, for 2022/07/30, they can be found at `Github Nightly`_.
+
+
+Installing from Apache Nightlies
+--------------------------------
+1. Look up the nightly version number for the Arrow libraries used.
+
+   For example, for ``arrow-memory``, visit  https://nightlies.apache.org/arrow/java/org/apache/arrow/arrow-memory/ and see what versions are available (e.g. 9.0.0.dev501).
+2. Add Apache Nightlies Repository to the Maven/Gradle project.
+
+.. code-block:: xml
+
+    <properties>
+        <arrow.version>9.0.0.dev501</arrow.version>
+    </properties>
+    ...
+    <repositories>
+        <repository>
+            <id>arrow-apache-nightlies</id>
+            <url>https://nightlies.apache.org/arrow/java</url>
+        </repository>
+    </repositories>
+    ...
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>arrow-vector</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+    </dependencies>
+    ...
+
+Installing Manually
+-------------------
+
+1. Decide nightly packages repository to use, for example: https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars
+2. Add packages to your pom.xml, for example: flight-core (it depends on: arrow-format, arrow-vector, arrow-memeory-core and arrow-memory-netty).
+
+.. code-block:: xml
+
+    <properties>
+        <maven.compiler.source>8</maven.compiler.source>
+        <maven.compiler.target>8</maven.compiler.target>
+        <arrow.version>9.0.0.dev501</arrow.version>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>org.apache.arrow</groupId>
+            <artifactId>flight-core</artifactId>
+            <version>${arrow.version}</version>
+        </dependency>
+    </dependencies>
+
+3. Download the necessary pom and jar files to a temporary directory:
+
+.. code-block:: shell
+
+    $ mkdir nightly-packaging-2022-07-30-0-github-java-jars
+    $ cd nightly-packaging-2022-07-30-0-github-java-jars
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-java-root-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.jar
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.jar
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.jar
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.jar
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-flight-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.pom
+    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.jar
+    $ tree
+    .
+    ├── arrow-flight-9.0.0.dev501.pom
+    ├── arrow-format-9.0.0.dev501.jar
+    ├── arrow-format-9.0.0.dev501.pom
+    ├── arrow-java-root-9.0.0.dev501.pom
+    ├── arrow-memory-9.0.0.dev501.pom
+    ├── arrow-memory-core-9.0.0.dev501.jar
+    ├── arrow-memory-core-9.0.0.dev501.pom
+    ├── arrow-memory-netty-9.0.0.dev501.jar
+    ├── arrow-memory-netty-9.0.0.dev501.pom
+    ├── arrow-vector-9.0.0.dev501.jar
+    ├── arrow-vector-9.0.0.dev501.pom
+    ├── flight-core-9.0.0.dev501.jar
+    └── flight-core-9.0.0.dev501.pom
+
+4. Install the artifacts to the local Maven repository with ``mvn install:install-file``:
+
+.. code-block:: shell
+
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-java-root-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-java-root -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-format-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-format -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-format-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-format -Dversion=9.0.0.dev501 -Dpackaging=jar
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-vector-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-vector -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-vector-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-vector -Dversion=9.0.0.dev501 -Dpackaging=jar
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-core-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-core -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-netty-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-netty -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-core-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-core -Dversion=9.0.0.dev501 -Dpackaging=jar
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-netty-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-netty -Dversion=9.0.0.dev501 -Dpackaging=jar
+    $ mvn install:install-file -Dfile="$(pwd)/arrow-flight-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-flight -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/flight-core-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=flight-core -Dversion=9.0.0.dev501 -Dpackaging=pom
+    $ mvn install:install-file -Dfile="$(pwd)/flight-core-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=flight-core -Dversion=9.0.0.dev501 -Dpackaging=jar
+
+5. Validate that the packages were installed:
+
+.. code-block:: shell
+
+    $ tree ~/.m2/repository/org/apache/arrow
+    .
+    ├── arrow-flight
+    │   ├── 9.0.0.dev501
+    │   │   └── arrow-flight-9.0.0.dev501.pom
+    ├── arrow-format
+    │   ├── 9.0.0.dev501
+    │   │   ├── arrow-format-9.0.0.dev501.jar
+    │   │   └── arrow-format-9.0.0.dev501.pom
+    ├── arrow-java-root
+    │   ├── 9.0.0.dev501
+    │   │   └── arrow-java-root-9.0.0.dev501.pom
+    ├── arrow-memory
+    │   ├── 9.0.0.dev501
+    │   │   └── arrow-memory-9.0.0.dev501.pom
+    ├── arrow-memory-core
+    │   ├── 9.0.0.dev501
+    │   │   ├── arrow-memory-core-9.0.0.dev501.jar
+    │   │   └── arrow-memory-core-9.0.0.dev501.pom
+    ├── arrow-memory-netty
+    │   ├── 9.0.0.dev501
+    │   │   ├── arrow-memory-netty-9.0.0.dev501.jar
+    │   │   └── arrow-memory-netty-9.0.0.dev501.pom
+    ├── arrow-vector
+    │   ├── 9.0.0.dev501
+    │   │   ├── _remote.repositories
+    │   │   ├── arrow-vector-9.0.0.dev501.jar
+    │   │   └── arrow-vector-9.0.0.dev501.pom
+    └── flight-core
+        ├── 9.0.0.dev501
+        │   ├── flight-core-9.0.0.dev501.jar
+        │   └── flight-core-9.0.0.dev501.pom
+
+6. Compile your project like usual with ``mvn clean install``.
+
+.. _builds@arrow.apache.org: https://lists.apache.org/list.html?builds@arrow.apache.org
+.. _Github Nightly: https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars
diff --git a/docs/source/developers/python.rst b/docs/source/developers/python.rst
@@ -388,7 +388,7 @@ Similarly, if you built with ``PARQUET_REQUIRE_ENCRYPTION`` (in C++), you
 need to set the corresponding ``PYARROW_WITH_PARQUET_ENCRYPTION`` environment
 variable to 1.
 
-To set the number of threads used to compile PyArrow's C++/Cython components, 
+To set the number of threads used to compile PyArrow's C++/Cython components,
 set the ``PYARROW_PARALLEL`` environment variable.
 
 If you wish to delete stale PyArrow build artifacts before rebuilding, navigate
@@ -604,3 +604,30 @@ Caveats
 -------
 
 The Plasma component is not supported on Windows.
+
+Installing Nightly Packages
+===========================
+
+.. warning::
+    These packages are not official releases. Use them at your own risk.
+
+PyArrow has nightly wheels and Conda packages for testing purposes.
+
+These may be suitable for downstream libraries in their continuous integration
+setup to maintain compatibility with the upcoming PyArrow features,
+deprecations and/or feature removals.
+
+Install the development version of PyArrow from `arrow-nightlies
+<https://anaconda.org/arrow-nightlies/pyarrow>`_ conda channel:
+
+.. code-block:: bash
+
+    conda install -c arrow-nightlies pyarrow
+
+Install the development version from an `alternative PyPI
+<https://gemfury.com/arrow-nightlies>`_ index:
+
+.. code-block:: bash
+
+    pip install --extra-index-url https://pypi.fury.io/arrow-nightlies/ \
+        --prefer-binary --pre pyarrow
diff --git a/docs/source/java/install.rst b/docs/source/java/install.rst
@@ -134,158 +134,3 @@ Installing from Source
 ----------------------
 
 See :ref:`java-development`.
-
-Installing Nightly Packages
----------------------------
-
-.. warning::
-    These packages are not official releases. Use them at your own risk.
-
-Arrow nightly builds are posted on the mailing list at `builds@arrow.apache.org`_.
-The artifacts are uploaded to GitHub. For example, for 2022/03/01, they can be found at `Github Nightly`_.
-
-Installing from Apache Nightlies
-********************************
-1. Look up the nightly version number for the Arrow libraries used.
-
-   For example, for ``arrow-memory``, visit  https://nightlies.apache.org/arrow/java/org/apache/arrow/arrow-memory/ and see what versions are available (e.g. 9.0.0.dev501).
-2. Add Apache Nightlies Repository to the Maven/Gradle project.
-
-.. code-block:: xml
-
-    <properties>
-        <arrow.version>9.0.0.dev501</arrow.version>
-    </properties>
-    ...
-    <repositories>
-        <repository>
-            <id>arrow-apache-nightlies</id>
-            <url>https://nightlies.apache.org/arrow/java</url>
-        </repository>
-    </repositories>
-    ...
-    <dependencies>
-        <dependency>
-            <groupId>org.apache.arrow</groupId>
-            <artifactId>arrow-vector</artifactId>
-            <version>${arrow.version}</version>
-        </dependency>
-    </dependencies>
-    ...
-
-Installing Manually
-*******************
-
-1. Decide nightly packages repository to use, for example: https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars
-2. Add packages to your pom.xml, for example: flight-core (it depends on: arrow-format, arrow-vector, arrow-memeory-core and arrow-memory-netty).
-
-.. code-block:: xml
-
-    <properties>
-        <maven.compiler.source>8</maven.compiler.source>
-        <maven.compiler.target>8</maven.compiler.target>
-        <arrow.version>9.0.0.dev501</arrow.version>
-    </properties>
-
-    <dependencies>
-        <dependency>
-            <groupId>org.apache.arrow</groupId>
-            <artifactId>flight-core</artifactId>
-            <version>${arrow.version}</version>
-        </dependency>
-    </dependencies>
-
-3. Download the necessary pom and jar files to a temporary directory:
-
-.. code-block:: shell
-
-    $ mkdir nightly-packaging-2022-07-30-0-github-java-jars
-    $ cd nightly-packaging-2022-07-30-0-github-java-jars
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-java-root-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-format-9.0.0.dev501.jar
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-vector-9.0.0.dev501.jar
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-core-9.0.0.dev501.jar
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-memory-netty-9.0.0.dev501.jar
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/arrow-flight-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.pom
-    $ wget https://github.com/ursacomputing/crossbow/releases/download/nightly-packaging-2022-07-30-0-github-java-jars/flight-core-9.0.0.dev501.jar
-    $ tree
-    .
-    ├── arrow-flight-9.0.0.dev501.pom
-    ├── arrow-format-9.0.0.dev501.jar
-    ├── arrow-format-9.0.0.dev501.pom
-    ├── arrow-java-root-9.0.0.dev501.pom
-    ├── arrow-memory-9.0.0.dev501.pom
-    ├── arrow-memory-core-9.0.0.dev501.jar
-    ├── arrow-memory-core-9.0.0.dev501.pom
-    ├── arrow-memory-netty-9.0.0.dev501.jar
-    ├── arrow-memory-netty-9.0.0.dev501.pom
-    ├── arrow-vector-9.0.0.dev501.jar
-    ├── arrow-vector-9.0.0.dev501.pom
-    ├── flight-core-9.0.0.dev501.jar
-    └── flight-core-9.0.0.dev501.pom
-
-4. Install the artifacts to the local Maven repository with ``mvn install:install-file``:
-
-.. code-block:: shell
-
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-java-root-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-java-root -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-format-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-format -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-format-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-format -Dversion=9.0.0.dev501 -Dpackaging=jar
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-vector-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-vector -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-vector-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-vector -Dversion=9.0.0.dev501 -Dpackaging=jar
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-core-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-core -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-netty-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-netty -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-core-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-core -Dversion=9.0.0.dev501 -Dpackaging=jar
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-memory-netty-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=arrow-memory-netty -Dversion=9.0.0.dev501 -Dpackaging=jar
-    $ mvn install:install-file -Dfile="$(pwd)/arrow-flight-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=arrow-flight -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/flight-core-9.0.0.dev501.pom" -DgroupId=org.apache.arrow -DartifactId=flight-core -Dversion=9.0.0.dev501 -Dpackaging=pom
-    $ mvn install:install-file -Dfile="$(pwd)/flight-core-9.0.0.dev501.jar" -DgroupId=org.apache.arrow -DartifactId=flight-core -Dversion=9.0.0.dev501 -Dpackaging=jar
-
-5. Validate that the packages were installed:
-
-.. code-block:: shell
-
-    $ tree ~/.m2/repository/org/apache/arrow
-    .
-    ├── arrow-flight
-    │   ├── 9.0.0.dev501
-    │   │   └── arrow-flight-9.0.0.dev501.pom
-    ├── arrow-format
-    │   ├── 9.0.0.dev501
-    │   │   ├── arrow-format-9.0.0.dev501.jar
-    │   │   └── arrow-format-9.0.0.dev501.pom
-    ├── arrow-java-root
-    │   ├── 9.0.0.dev501
-    │   │   └── arrow-java-root-9.0.0.dev501.pom
-    ├── arrow-memory
-    │   ├── 9.0.0.dev501
-    │   │   └── arrow-memory-9.0.0.dev501.pom
-    ├── arrow-memory-core
-    │   ├── 9.0.0.dev501
-    │   │   ├── arrow-memory-core-9.0.0.dev501.jar
-    │   │   └── arrow-memory-core-9.0.0.dev501.pom
-    ├── arrow-memory-netty
-    │   ├── 9.0.0.dev501
-    │   │   ├── arrow-memory-netty-9.0.0.dev501.jar
-    │   │   └── arrow-memory-netty-9.0.0.dev501.pom
-    ├── arrow-vector
-    │   ├── 9.0.0.dev501
-    │   │   ├── _remote.repositories
-    │   │   ├── arrow-vector-9.0.0.dev501.jar
-    │   │   └── arrow-vector-9.0.0.dev501.pom
-    └── flight-core
-        ├── 9.0.0.dev501
-        │   ├── flight-core-9.0.0.dev501.jar
-        │   └── flight-core-9.0.0.dev501.pom
-
-6. Compile your project like usual with ``mvn clean install``.
-
-.. _builds@arrow.apache.org: https://lists.apache.org/list.html?builds@arrow.apache.org
-.. _Github Nightly: https://github.com/ursacomputing/crossbow/releases/tag/nightly-packaging-2022-07-30-0-github-java-jars