lidavidm commented on a change in pull request #12538: URL: https://github.com/apache/arrow/pull/12538#discussion_r817674075
########## File path: docs/source/java/install.rst ########## @@ -0,0 +1,148 @@ +.. 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. + +Installing Java Modules +======================= + +System Compatibility +-------------------- + +Java modules are regularly built and tested on macOS and Linux distributions. + +Java Compatibility +------------------ + +Java modules is currently compatible with JDK 8 / 9 / 10 / 11. + +Using Maven +----------- + +Downloading in Maven is triggered by a project declaring a dependency that is not present in the local repository. + +Central Repository +****************** + +By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/ + +Configure your pom.xml with java module version needed. For example: + +.. code-block:: + + <dependency> + <groupId>org.apache.arrow</groupId> + <artifactId>arrow-vector</artifactId> + <version>7.0.0</version> + </dependency Review comment: There's a missing bracket here, also, shouldn't we show the 'full' set of dependencies needed? i.e. memory-netty, format, and vector? We also don't need to explain Maven or pom.xml here. Just state what modules are needed and show the example XML. ########## File path: docs/source/java/install.rst ########## @@ -0,0 +1,148 @@ +.. 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. + +Installing Java Modules +======================= + +System Compatibility +-------------------- + +Java modules are regularly built and tested on macOS and Linux distributions. + +Java Compatibility +------------------ + +Java modules is currently compatible with JDK 8 / 9 / 10 / 11. Review comment: ```suggestion Java modules are currently compatible with Java 8 / 9 / 10 / 11. ``` ########## File path: docs/source/java/install.rst ########## @@ -0,0 +1,148 @@ +.. 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. + +Installing Java Modules +======================= + +System Compatibility +-------------------- + +Java modules are regularly built and tested on macOS and Linux distributions. + +Java Compatibility +------------------ + +Java modules is currently compatible with JDK 8 / 9 / 10 / 11. + +Using Maven +----------- + +Downloading in Maven is triggered by a project declaring a dependency that is not present in the local repository. Review comment: I don't think we need to explain how Maven works to Java developers. ########## File path: docs/source/java/install.rst ########## @@ -0,0 +1,148 @@ +.. 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. + +Installing Java Modules +======================= + +System Compatibility +-------------------- + +Java modules are regularly built and tested on macOS and Linux distributions. + +Java Compatibility +------------------ + +Java modules is currently compatible with JDK 8 / 9 / 10 / 11. + +Using Maven +----------- + +Downloading in Maven is triggered by a project declaring a dependency that is not present in the local repository. + +Central Repository +****************** + +By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/ + +Configure your pom.xml with java module version needed. For example: + +.. code-block:: + + <dependency> + <groupId>org.apache.arrow</groupId> + <artifactId>arrow-vector</artifactId> + <version>7.0.0</version> + </dependency + +Staging Repository +****************** + +Configure your maven settings.xml to download artifacts from staging repository with: + +.. code-block:: xml + + $ cat ~/.m2/settings.xml + <?xml version="1.0" encoding="UTF-8"?> + <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"; xmlns="http://maven.apache.org/SETTINGS/1.1.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";> + <profiles> + <profile> + <repositories> + <repository> + <id>staged</id> + <name>staged-releases</name> + <url>https://repository.apache.org/content/repositories/staging/</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + </snapshots> + </repository> + </repositories> + <id>arrowrc</id> + </profile> + </profiles> + </settings> + $ mvn -Parrowrc clean install -X + Downloading from staged: https://repository.apache.org/content/repositories/staging/ + +Installing from source +---------------------- + +See :ref:`java-development`. + +Installing Nightly Packages +--------------------------- + +.. warning:: + These packages are not official releases. Use them at your own risk. + +All arrow nightly version are uploaded to github assets for example for March 01 it is uploading to `Github Nightly`_ + +.. image:: img/java_nightly_github_asset.png Review comment: I don't think we need the image. Also, we can just link to GitHub. ########## File path: docs/source/java/install.rst ########## @@ -0,0 +1,148 @@ +.. 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. + +Installing Java Modules +======================= + +System Compatibility +-------------------- + +Java modules are regularly built and tested on macOS and Linux distributions. + +Java Compatibility +------------------ + +Java modules is currently compatible with JDK 8 / 9 / 10 / 11. + +Using Maven +----------- + +Downloading in Maven is triggered by a project declaring a dependency that is not present in the local repository. + +Central Repository +****************** + +By default, Maven will download from the central repository: https://repo.maven.apache.org/maven2/org/apache/arrow/ + +Configure your pom.xml with java module version needed. For example: + +.. code-block:: + + <dependency> + <groupId>org.apache.arrow</groupId> + <artifactId>arrow-vector</artifactId> + <version>7.0.0</version> + </dependency + +Staging Repository +****************** + +Configure your maven settings.xml to download artifacts from staging repository with: + +.. code-block:: xml + + $ cat ~/.m2/settings.xml + <?xml version="1.0" encoding="UTF-8"?> + <settings xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.1.0 http://maven.apache.org/xsd/settings-1.1.0.xsd"; xmlns="http://maven.apache.org/SETTINGS/1.1.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";> + <profiles> + <profile> + <repositories> + <repository> + <id>staged</id> + <name>staged-releases</name> + <url>https://repository.apache.org/content/repositories/staging/</url> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + </snapshots> + </repository> + </repositories> + <id>arrowrc</id> + </profile> + </profiles> + </settings> + $ mvn -Parrowrc clean install -X + Downloading from staged: https://repository.apache.org/content/repositories/staging/ + +Installing from source +---------------------- + +See :ref:`java-development`. + +Installing Nightly Packages Review comment: If these are the nightly packages, then what is the purpose of the staging repository above? -- 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-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
