From 63270d7f2474b00dfe6ea745dc666fc7fc2a501f Mon Sep 17 00:00:00 2001 From: tison Date: Mon, 29 Apr 2024 00:54:57 +0800 Subject: [PATCH 1/3] docs: add download page Signed-off-by: tison --- docs/source/download.md | 66 +++++++++++++++++++++++++ docs/source/index.rst | 3 +- docs/source/user-guide/example-usage.md | 2 +- 3 files changed, 69 insertions(+), 2 deletions(-) create mode 100644 docs/source/download.md diff --git a/docs/source/download.md b/docs/source/download.md new file mode 100644 index 000000000000..b3f65f2b6457 --- /dev/null +++ b/docs/source/download.md @@ -0,0 +1,66 @@ + + +# Download + +The official Apache DataFusion releases are provided as source artifacts. + +## Releases + +The latest source release is [37.0.0][source-link] ([asc][asc-link], +[sha512][sha512-link]). + +[source-link]: https://www.apache.org/dyn/closer.lua/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz?action=download +[asc-link]: https://downloads.apache.org/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.asc +[sha512-link]: https://downloads.apache.org/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.sha512 + +For older releases, please check the [archive](https://archive.apache.org/dist/datafusion/). + +For even older releases when DataFusion is a subproject of Apache Arrow, please check [Arrow's archive](https://archive.apache.org/dist/arrow/). + +## Notes + +- When downloading a release, please verify the OpenPGP compatible signature (or failing that, check the SHA-512); these should be fetched from the main Apache site. +- The KEYS file contains the public keys used for signing release. It is recommended that (when possible) a web of trust is used to confirm the identity of these keys. +- Please download the [KEYS](https://downloads.apache.org/datafusion/KEYS) as well as the .asc signature files. + +### To verify the signature of the release artifact + +You will need to download both the release artifact and the .asc signature file for that artifact. Then verify the signature by: + +- Download the KEYS file and the .asc signature files for the relevant release artifacts. +- Import the KEYS file to your GPG keyring: + + ```shell + gpg --import KEYS + ``` + +- Verify the signature of the release artifact using the following command: + + ```shell + gpg --verify .asc + ``` + +### To verify the checksum of the release artifact + +You will need to download both the release artifact and the .sha512 checksum file for that artifact. Then verify the checksum by: + +```shell +shasum -a 512 -c .sha512 +``` diff --git a/docs/source/index.rst b/docs/source/index.rst index 84d920bd66c9..50c22d50587b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -66,10 +66,11 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for :maxdepth: 1 :caption: Links - Github and Issue Tracker + GitHub and Issue Tracker crates.io API Docs Code of conduct + Download .. _toc.guide: .. toctree:: diff --git a/docs/source/user-guide/example-usage.md b/docs/source/user-guide/example-usage.md index 2fb4e55d698d..ae45c98d7483 100644 --- a/docs/source/user-guide/example-usage.md +++ b/docs/source/user-guide/example-usage.md @@ -36,7 +36,7 @@ tokio = "1.0" ## Add latest non published DataFusion dependency DataFusion changes are published to `crates.io` according to [release schedule](https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process) -In case if it is required to test out DataFusion changes which are merged but yet to be published, Cargo supports adding dependency directly to Github branch +In case if it is required to test out DataFusion changes which are merged but yet to be published, Cargo supports adding dependency directly to GitHub branch ```toml datafusion = { git = "https://github.com/apache/datafusion", branch = "main"} From ce50c3dd4c9480567e8caa2687b07baf1a157af2 Mon Sep 17 00:00:00 2001 From: tison Date: Mon, 29 Apr 2024 10:55:02 +0800 Subject: [PATCH 2/3] Apply suggestions from code review Co-authored-by: Phillip LeBlanc --- docs/source/download.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/download.md b/docs/source/download.md index b3f65f2b6457..3774507cf0b0 100644 --- a/docs/source/download.md +++ b/docs/source/download.md @@ -30,9 +30,9 @@ The latest source release is [37.0.0][source-link] ([asc][asc-link], [asc-link]: https://downloads.apache.org/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.asc [sha512-link]: https://downloads.apache.org/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.sha512 -For older releases, please check the [archive](https://archive.apache.org/dist/datafusion/). +For previous releases, please check the [archive](https://archive.apache.org/dist/datafusion/). -For even older releases when DataFusion is a subproject of Apache Arrow, please check [Arrow's archive](https://archive.apache.org/dist/arrow/). +For older releases (<= 37) when DataFusion was a subproject of Apache Arrow, please check [Arrow's archive](https://archive.apache.org/dist/arrow/). ## Notes From 4f14a245a74e0781014b53c891d130b05751268d Mon Sep 17 00:00:00 2001 From: tison Date: Tue, 30 Apr 2024 08:27:23 +0800 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Andrew Lamb Signed-off-by: tison --- docs/source/download.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/source/download.md b/docs/source/download.md index 3774507cf0b0..0c279dd033f2 100644 --- a/docs/source/download.md +++ b/docs/source/download.md @@ -19,7 +19,10 @@ # Download -The official Apache DataFusion releases are provided as source artifacts. +While DataFusion is also distributed via the Rust [crates.io] package manager as a convenience, the +official Apache DataFusion releases are provided as source artifacts. + +[crates.io]: https://crates.io/crates/datafusion ## Releases @@ -32,7 +35,7 @@ The latest source release is [37.0.0][source-link] ([asc][asc-link], For previous releases, please check the [archive](https://archive.apache.org/dist/datafusion/). -For older releases (<= 37) when DataFusion was a subproject of Apache Arrow, please check [Arrow's archive](https://archive.apache.org/dist/arrow/). +For releases earlier than 37.0.0, please check [Arrow's archive](https://archive.apache.org/dist/arrow/). ## Notes