Skip to content

Commit a0b75c8

Browse files
committed
docs: add download page
Signed-off-by: tison <[email protected]>
1 parent ed14682 commit a0b75c8

File tree

3 files changed

+69
-2
lines changed

3 files changed

+69
-2
lines changed

docs/source/download.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
# Download
21+
22+
The official Apache DataFusion releases are provided as source artifacts.
23+
24+
## Releases
25+
26+
The latest source release is [37.0.0][source-link] ([asc][asc-link],
27+
[sha512][sha512-link]).
28+
29+
[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
30+
[asc-link]: https://www.apache.org/dyn/closer.lua/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.asc?action=download
31+
[sha512-link]: https://www.apache.org/dyn/closer.lua/arrow/arrow-datafusion-37.0.0/apache-arrow-datafusion-37.0.0.tar.gz.sha512?action=download
32+
33+
For older releases, please check the [archive](https://archive.apache.org/dist/datafusion/).
34+
35+
For even older releases when DataFusion is a subject of Apache Arrow, please check [Arrow's archive](https://archive.apache.org/dist/arrow/).
36+
37+
## Notes
38+
39+
- 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.
40+
- 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.
41+
- Please download the [KEYS](https://downloads.apache.org/datafusion/KEYS) as well as the .asc signature files.
42+
43+
### To verify the signature of the release artifact
44+
45+
You will need to download both the release artifact and the .asc signature file for that artifact. Then verify the signature by:
46+
47+
- Download the KEYS file and the .asc signature files for the relevant release artifacts.
48+
- Import the KEYS file to your GPG keyring:
49+
50+
```shell
51+
gpg --import KEYS
52+
```
53+
54+
- Verify the signature of the release artifact using the following command:
55+
56+
```shell
57+
gpg --verify <artifact>.asc <artifact>
58+
```
59+
60+
### To verify the checksum of the release artifact
61+
62+
You will need to download both the release artifact and the .sha512 checksum file for that artifact. Then verify the checksum by:
63+
64+
```shell
65+
shasum -a 512 -c <artifact>.sha512
66+
```

docs/source/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,11 @@ Please see the `developer’s guide`_ for contributing and `communication`_ for
6666
:maxdepth: 1
6767
:caption: Links
6868

69-
Github and Issue Tracker <https://github.com/apache/datafusion>
69+
GitHub and Issue Tracker <https://github.com/apache/datafusion>
7070
crates.io <https://crates.io/crates/datafusion>
7171
API Docs <https://docs.rs/datafusion/latest/datafusion/>
7272
Code of conduct <https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md>
73+
Download <download>
7374

7475
.. _toc.guide:
7576
.. toctree::

docs/source/user-guide/example-usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ tokio = "1.0"
3636
## Add latest non published DataFusion dependency
3737

3838
DataFusion changes are published to `crates.io` according to [release schedule](https://github.com/apache/datafusion/blob/main/dev/release/README.md#release-process)
39-
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
39+
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
4040

4141
```toml
4242
datafusion = { git = "https://github.com/apache/datafusion", branch = "main"}

0 commit comments

Comments
 (0)