You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sedona.apache.org by ji...@apache.org on 2023/10/12 10:15:24 UTC

[sedona] branch master updated: [DOCS] Add news for 1.5.0 (#1050)

This is an automated email from the ASF dual-hosted git repository.

jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git


The following commit(s) were added to refs/heads/master by this push:
     new d1ee421fd [DOCS] Add news for 1.5.0 (#1050)
d1ee421fd is described below

commit d1ee421fddef0f37634f43503e8f5c1a75ff1cad
Author: Jia Yu <ji...@apache.org>
AuthorDate: Thu Oct 12 03:15:19 2023 -0700

    [DOCS] Add news for 1.5.0 (#1050)
---
 docs/api/java-api.md        |  2 +-
 docs/api/sql/Overview.md    |  2 +-
 docs/api/viz/java-api.md    |  2 +-
 docs/community/publish.md   | 25 ++++++++++---------------
 docs/download.md            | 19 ++++++-------------
 docs/index.md               |  3 +--
 docs/setup/compile.md       |  3 +--
 docs/setup/release-notes.md | 18 +++++++++---------
 docs/tutorial/sql.md        |  2 +-
 mkdocs.yml                  |  4 ++--
 10 files changed, 33 insertions(+), 47 deletions(-)

diff --git a/docs/api/java-api.md b/docs/api/java-api.md
index 05ba1bb57..189362c6a 100644
--- a/docs/api/java-api.md
+++ b/docs/api/java-api.md
@@ -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
 
diff --git a/docs/api/sql/Overview.md b/docs/api/sql/Overview.md
index 6e0376838..cb8ce9e18 100644
--- a/docs/api/sql/Overview.md
+++ b/docs/api/sql/Overview.md
@@ -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)
 
diff --git a/docs/api/viz/java-api.md b/docs/api/viz/java-api.md
index 79a51e580..541763a1a 100644
--- a/docs/api/viz/java-api.md
+++ b/docs/api/viz/java-api.md
@@ -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
\ No newline at end of file
diff --git a/docs/community/publish.md b/docs/community/publish.md
index 5d32d6c97..644e9304a 100644
--- a/docs/community/publish.md
+++ b/docs/community/publish.md
@@ -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
@@ -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
 
@@ -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
 ```
 
@@ -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
@@ -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.
diff --git a/docs/download.md b/docs/download.md
index 8580cefcc..3997d58fe 100644
--- a/docs/download.md
+++ b/docs/download.md
@@ -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
 
diff --git a/docs/index.md b/docs/index.md
index dc8c883c0..14111da55 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -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.
diff --git a/docs/setup/compile.md b/docs/setup/compile.md
index e9e33078a..5822fd743 100644
--- a/docs/setup/compile.md
+++ b/docs/setup/compile.md
@@ -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
 ```
 
diff --git a/docs/setup/release-notes.md b/docs/setup/release-notes.md
index 4641a66ae..a292593e6 100644
--- a/docs/setup/release-notes.md
+++ b/docs/setup/release-notes.md
@@ -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
 
@@ -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>
@@ -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>
@@ -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>
@@ -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>
diff --git a/docs/tutorial/sql.md b/docs/tutorial/sql.md
index 2ad5d34ce..439322326 100644
--- a/docs/tutorial/sql.md
+++ b/docs/tutorial/sql.md
@@ -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"
 
diff --git a/mkdocs.yml b/mkdocs.yml
index 5255bb897..25e68f5dc 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -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