Skip to content

Commit

Permalink
[DOCS] Add news for 1.5.0 (#1050)
Browse files Browse the repository at this point in the history
  • Loading branch information
jiayuasu authored Oct 12, 2023
1 parent 7ee22de commit d1ee421
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/api/java-api.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Please read [Javadoc](../javadoc/core/)
Please read [Javadoc](../javadoc/spark/)

Note: Scala can call Java APIs seamlessly. That means Scala users use the same APIs with Java users

Expand Down
2 changes: 1 addition & 1 deletion docs/api/sql/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ myDataFrame.withColumn("geometry", expr("ST_*")).selectExpr("ST_*")
* Example: ST_Contains (A, B). Check if A fully contains B. Return "True" if yes, else return "False".
* Documentation: [Here](../Predicate)

Sedona also provides an Adapter to convert SpatialRDD <-> DataFrame. Please read [Adapter Scaladoc](../../javadoc/sql/org/apache/sedona/sql/utils/index.html)
Sedona also provides an Adapter to convert SpatialRDD <-> DataFrame. Please read [Adapter Scaladoc](../../scaladoc/spark/org/apache/sedona/sql/utils/index.html)

SedonaSQL supports SparkSQL query optimizer, documentation is [Here](../Optimizer)

Expand Down
2 changes: 1 addition & 1 deletion docs/api/viz/java-api.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Please read [Javadoc](../../javadoc/viz/)
Please read [Javadoc](../../javadoc/spark/)

Note: Scala can call Java APIs seamlessly. That means Scala users use the same APIs with Java users
25 changes: 10 additions & 15 deletions docs/community/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,22 +118,16 @@ echo "Compiling the source code..."
mkdir apache-sedona-{{ sedona_create_release.current_version }}-bin

cd apache-sedona-{{ sedona_create_release.current_version }}-src && mvn -q clean install -DskipTests -Dspark=3.0 -Dscala=2.12 && cd ..
cp apache-sedona-{{ sedona_create_release.current_version }}-src/common/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark-shaded/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/flink/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/flink-shaded/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/

cd apache-sedona-{{ sedona_create_release.current_version }}-src && mvn -q clean install -DskipTests -Dspark=3.0 -Dscala=2.13 && cd ..
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark-shaded/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/

cd apache-sedona-{{ sedona_create_release.current_version }}-src && mvn -q clean install -DskipTests -Dspark=3.4 -Dscala=2.12 && cd ..
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark-shaded/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/

cd apache-sedona-{{ sedona_create_release.current_version }}-src && mvn -q clean install -DskipTests -Dspark=3.4 -Dscala=2.13 && cd ..
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/
cp apache-sedona-{{ sedona_create_release.current_version }}-src/spark-shaded/target/sedona-*{{ sedona_create_release.current_version}}.jar apache-sedona-{{ sedona_create_release.current_version }}-bin/

tar czf apache-sedona-{{ sedona_create_release.current_version }}-bin.tar.gz apache-sedona-{{ sedona_create_release.current_version }}-bin
Expand Down Expand Up @@ -194,7 +188,7 @@ https://dist.apache.org/repos/dist/dev/sedona/{{ sedona_create_release.current_r
The vote will be open for at least 72 hours or until at least 3 "+1" PMC votes are cast
Instruction for checking items on the checklist: https://sedona.apache.org/community/vote/
Instruction for checking items on the checklist: https://sedona.apache.org/latest/community/vote/
We recommend you use this Jupyter notebook on MyBinder to perform this task: https://mybinder.org/v2/gh/jiayuasu/sedona-tools/HEAD?labpath=binder%2Fverify-release.ipynb
Expand Down Expand Up @@ -370,7 +364,7 @@ cp -r sedona-{{ sedona_create_release.current_git_tag}}/* apache-sedona-{{ sedon

rm -rf sedona-{{ sedona_create_release.current_git_tag}}

cd zeppelin && npm publish && cd ..
cd apache-sedona-{{ sedona_create_release.current_version }}-src/zeppelin && npm publish && cd ..
rm -rf apache-sedona-{{ sedona_create_release.current_version }}-src
```

Expand Down Expand Up @@ -401,12 +395,13 @@ Run the following script to build Javadoc and Scaladoc of sedona modules and mov
#!/bin/bash

mvn -q clean install -DskipTests
rm -rf docs/api/javadoc && mkdir docs/api/javadoc
mv core/target/apidocs docs/api/javadoc/core
mv viz/target/apidocs docs/api/javadoc/viz
mv sql/common/target/site/scaladocs docs/api/javadoc/sql
rm -rf docs/api/javadoc && mkdir -p docs/api/javadoc
mkdir -p docs/api/javadoc/spark
mv spark/common/target/apidocs/* docs/api/javadoc/spark
```

Please use Intellij IDEA to generate Scaladoc for the spark-common module and paste to `docs/api/javadoc/spark`.

Please do not commit these generated docs to Sedona GitHub.

### Compile R html docs
Expand All @@ -415,10 +410,10 @@ From [GitHub Action docs workflow](https://github.com/apache/sedona/actions/work

### Deploy the website

1. Run `mike deploy --push --update-aliases {{ sedona_create_release.current_version }} latest`. This will deploy this website to Sedona main repo's gh-page. But Sedona does not use gh-page for hosting website.
1. Run `mike deploy --update-aliases {{ sedona_create_release.current_version }} latest -b website -p`. This will deploy this website to Sedona main repo's `website`.
2. Check out the master branch.
3. Git commit and push your changes in `download.md` and `index.md` to master branch. Delete all generated docs.
4. Check out the `gh-page` branch.
4. Check out the `website` branch.
5. In a separate folder, check out GitHub sedona-website [asf-site branch](https://github.com/apache/sedona-website/tree/asf-site)
6. Copy all content to in Sedona main repo `gh-page` branch to Sedona website repo `asf-site` branch.
6. Copy all content to in Sedona main repo `website` branch to Sedona website repo `asf-site` branch.
7. Commit and push the changes to the remote `asf-site` branch.
19 changes: 6 additions & 13 deletions docs/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,19 @@ Automatically generated binary JARs (per each Master branch commit): [GitHub Act

## Versions

### 1.4.1

| | Download from ASF | Checksum | Signature |
|:-----------------:|:--------:|:--------:|:---------:|
| Source code | [src](https://www.apache.org/dyn/closer.lua/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz.asc) |
| Binary | [bin](https://www.apache.org/dyn/closer.lua/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz.asc)

### 1.4.0
### 1.5.0

| | Download from ASF | Checksum | Signature |
|:-----------------:|:--------:|:--------:|:---------:|
| Source code | [src](https://www.apache.org/dyn/closer.lua/sedona/1.4.0/apache-sedona-1.4.0-src.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.0/apache-sedona-1.4.0-src.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.0/apache-sedona-1.4.0-src.tar.gz.asc) |
| Binary | [bin](https://www.apache.org/dyn/closer.lua/sedona/1.4.0/apache-sedona-1.4.0-bin.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.0/apache-sedona-1.4.0-bin.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.0/apache-sedona-1.4.0-bin.tar.gz.asc)
| Source code | [src](https://www.apache.org/dyn/closer.lua/sedona/1.5.0/apache-sedona-1.5.0-src.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.5.0/apache-sedona-1.5.0-src.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.5.0/apache-sedona-1.5.0-src.tar.gz.asc) |
| Binary | [bin](https://www.apache.org/dyn/closer.lua/sedona/1.5.0/apache-sedona-1.5.0-bin.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.5.0/apache-sedona-1.5.0-bin.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.5.0/apache-sedona-1.5.0-bin.tar.gz.asc)

### 1.3.1-incubating
### 1.4.1

| | Download from ASF | Checksum | Signature |
|:-----------------:|:--------:|:--------:|:---------:|
| Source code | [src](https://www.apache.org/dyn/closer.lua/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-src.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-src.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-src.tar.gz.asc) |
| Binary | [bin](https://www.apache.org/dyn/closer.lua/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-bin.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-bin.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.3.1-incubating/apache-sedona-1.3.1-incubating-bin.tar.gz.asc)
| Source code | [src](https://www.apache.org/dyn/closer.lua/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-src.tar.gz.asc) |
| Binary | [bin](https://www.apache.org/dyn/closer.lua/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz) | [sha512](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz.sha512) | [asc](https://downloads.apache.org/sedona/1.4.1/apache-sedona-1.4.1-bin.tar.gz.asc)

### Past releases

Expand Down
3 changes: 1 addition & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
### 10/12/2023: Sedona 1.5.0 released. It adds comprehensive raster data ETL and analytics, native support of Uber H3 functions, and SedonaKepler / SedonaPyDeck for interactive map visualization
### 06/25/2023: Sedona 1.4.1 released. It adds geodesic / geography functions, more raster functions and support Spark 3.4.
### 03/19/2023: Sedona 1.4.0 released. It provides GeoParquet filter pushdown (10X less memory footprint), faster serialization (3X speed), S2-based fast approximate join and enhanced R language support
### 01/2023: Apache Sedona graduated to an Apache Top Level Project!
### 12/23/2022: Sedona 1.3.1-incubating is released. It adds native support of GeoParquet, DataFrame style API, Scala 2.13, Python 3.10, spatial aggregation on Flink. Please check Sedona release notes.
### 08/30/2022: Sedona 1.2.1-incubating is released. It supports Spark 2.4 - 3.3. and Flink 1.12+.
### 04/16/2022: Sedona 1.2.0-incubating is released. Sedona now supports geospatial stream processing in Apache Flink.
3 changes: 1 addition & 2 deletions docs/setup/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,7 @@ After installing MkDocs and MkDocs-Material, run the command in Sedona root fold

```
mkdocs build
mike deploy --update-aliases latest-snapshot latest
mike set-default latest
mike deploy --update-aliases latest-snapshot -b website -p
mike serve
```

18 changes: 9 additions & 9 deletions docs/setup/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Sedona 1.5.0

Sedona 1.4.1 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
Sedona 1.5.0 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.

### Highlights

Expand Down Expand Up @@ -37,8 +37,8 @@ Sedona 1.4.1 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
* Add SedonaKepler and SedonaPyDeck for [interactive map visualization](../../tutorial/sql/#visualize-query-results) on Sedona Spark.


<h2> Bug
</h2>
### Bug

<ul>
<li>[<a href='https://issues.apache.org/jira/browse/SEDONA-318'>SEDONA-318</a>] - SerDe for RasterUDT performs poorly
</li>
Expand Down Expand Up @@ -76,8 +76,8 @@ Sedona 1.4.1 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
</li>
</ul>
<h2> New Feature
</h2>
### New Feature

<ul>
<li>[<a href='https://issues.apache.org/jira/browse/SEDONA-200'>SEDONA-200</a>] - Add ST_CoordDim to Sedona
</li>
Expand Down Expand Up @@ -187,8 +187,8 @@ Sedona 1.4.1 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
</li>
</ul>
<h2> Improvement
</h2>
### Improvement

<ul>
<li>[<a href='https://issues.apache.org/jira/browse/SEDONA-39'>SEDONA-39</a>] - Fix the Lon/lat order issue in Sedona
</li>
Expand Down Expand Up @@ -234,8 +234,8 @@ Sedona 1.4.1 is compiled against Spark 3.3 / Spark 3.4 / Flink 1.12, Java 8.
</li>
</ul>
<h2> Task
</h2>
### Task

<ul>
<li>[<a href='https://issues.apache.org/jira/browse/SEDONA-316'>SEDONA-316</a>] - Refactor Sedona Jupyter notebook examples with unified SedonaContext entrypoint
</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -762,7 +762,7 @@ my_postgis_db# alter table my_table alter column geom type geometry;

### DataFrame to SpatialRDD

Use SedonaSQL DataFrame-RDD Adapter to convert a DataFrame to an SpatialRDD. Please read [Adapter Scaladoc](../../api/javadoc/sql/org/apache/sedona/sql/utils/index.html)
Use SedonaSQL DataFrame-RDD Adapter to convert a DataFrame to an SpatialRDD. Please read [Adapter Scaladoc](../../api/scaladoc/spark/org/apache/sedona/sql/utils/index.html)

=== "Scala"

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,8 @@ extra:
- icon: fontawesome/brands/twitter
link: 'https://twitter.com/ApacheSedona'
sedona:
current_version: 1.4.1
current_geotools: 1.4.0-28.2
current_version: 1.5.0
current_geotools: 1.5.0-28.2
sedona_create_release:
current_version: 1.5.0
current_git_tag: sedona-1.5.0-rc1
Expand Down

0 comments on commit d1ee421

Please sign in to comment.