Skip to content

Conversation

MrPowers
Copy link
Collaborator

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a documentation update. The PR name follows the format [DOCS] my subject

What changes were proposed in this PR?

Updates the homepage with links and some tweaks.

How was this patch tested?

Tested locally with mkdocs serve.

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation.

@MrPowers MrPowers requested a review from jiayuasu as a code owner September 16, 2025 22:12
@github-actions github-actions bot added the docs label Sep 16, 2025
@jiayuasu jiayuasu requested a review from Copilot September 16, 2025 23:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Apache Sedona homepage documentation with new links and content improvements. The changes replace placeholder links with actual URLs, update installation commands, and modify the user experience examples.

  • Replace SQL example with spatial query example showcasing Sedona functionality
  • Update installation commands and tab ordering to prioritize PySpark
  • Add functional links to documentation, GitHub repositories, and community resources

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.


<!-- Section Get Started -->
<section class="section-get-started">
<!-- <section class="section-get-started">
Copy link
Preview

Copilot AI Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider removing this commented-out section entirely rather than leaving it as commented code, which can create maintenance overhead and confusion.

Copilot uses AI. Check for mistakes.

</div>
</section>
</section> -->
Copy link
Preview

Copilot AI Sep 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider removing this commented-out section entirely rather than leaving it as commented code, which can create maintenance overhead and confusion.

Copilot uses AI. Check for mistakes.

@jiayuasu
Copy link
Member

Thanks for the PR.

Some comments

  1. The example spatial queries need to be carefully crafted. This is the one we currently use on Sedona main page and I suggest we still use it. This is a classical Spatial SQL example from PostGIS.
SELECT superhero.name
FROM city, superhero
WHERE ST_Contains(city.geom, superhero.geom)
AND city.name = 'Gotham'

Please prepare the same example for (1) SedonaSpark (2) SedonaDB. Don't do any Java example or irrelevant PySpark example.

  1. Please do not use Sedona Snowflake in any coding example or deployment as it is impossible to run them locally.

I suggest the following deployment mode

SedonaSpark

pip install apache-sedona

SedonaSpark in Docker

docker pull apache/sedona:latest
docker run -d -p 8888:8888 -p 8085:8085 apache/sedona:latest

SedonaDB

pip install apache-sedona[db]

<div class="info-item__description editor">Distributed batch processing on Apache Spark clusters.</div>
<div class="info-item__cta">
<a href="#" class="btn-link">
<a href="https://sedona.apache.org/latest/setup/overview/" class="btn-link">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't use absolute paths, use relative path instead.

I believe it will look like "setup/overview/". Please try locally.

<div class="info-item__description editor">Real-time spatial analytics using Apache Flink.</div>
<div class="info-item__cta">
<a href="#" class="btn-link">
<a href="https://sedona.apache.org/latest/setup/flink/install-scala/" class="btn-link">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here. There are a few other places as well.

Please don't use absolute paths, use relative path instead.

I believe it will look like "setup/overview/". Please try locally.

jiayuasu and others added 2 commits September 18, 2025 11:30
Co-authored-by: Kelly-Ann Dolor <[email protected]>
change from absolute to relative paths
@jiayuasu jiayuasu merged commit 49e9842 into apache:master Sep 18, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants