Skip to content

[GH-2227] Add Geopandas Developer Guide README.md #2229

Merged
jiayuasu merged 10 commits intoapache:masterfrom
petern48:geopandas_readme
Aug 6, 2025
Merged

[GH-2227] Add Geopandas Developer Guide README.md #2229
jiayuasu merged 10 commits intoapache:masterfrom
petern48:geopandas_readme

Conversation

@petern48
Copy link
Contributor

@petern48 petern48 commented Aug 5, 2025

Did you read the Contributor Guide?

Is this PR related to a ticket?

What changes were proposed in this PR?

Add Geopandas Developer Guide README.md

How was this patch tested?

N/A

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation.

@petern48 petern48 marked this pull request as ready for review August 5, 2025 18:09
@petern48 petern48 requested a review from jiayuasu as a code owner August 5, 2025 18:09
@jiayuasu
Copy link
Member

jiayuasu commented Aug 5, 2025

Can you actually move this to be a new page under Contributor guide section here? https://sedona.apache.org/latest/community/develop/

Our website gets nightly built and published at latest-snapshot version

image

This comment was marked as outdated.

jiayuasu and others added 2 commits August 6, 2025 00:20
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jiayuasu jiayuasu requested a review from Copilot August 6, 2025 07:20

This comment was marked as outdated.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jiayuasu jiayuasu requested a review from Copilot August 6, 2025 07:22

This comment was marked as outdated.

@petern48
Copy link
Contributor Author

petern48 commented Aug 6, 2025

Just added an example of explain plan output and moved the sections a bit, but otherwise changes look good to me.

@jiayuasu jiayuasu requested a review from Copilot August 6, 2025 18:40
Copy link
Contributor

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 adds comprehensive developer documentation for contributing to the Geopandas component of Apache Sedona. The guide provides technical guidance for developers working on Sedona's GeoPandas implementation, focusing on the unique challenges of building GeoPandas functionality on top of PySpark's distributed computing model.

  • Adds a new developer guide specifically for GeoPandas contributors
  • Documents key technical considerations like lazy evaluation, order maintenance, and naming conventions
  • Includes practical examples and references for developers

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
mkdocs.yml Adds navigation entry for the new GeoPandas developer guide
docs/community/geopandas.md Creates comprehensive developer documentation covering GeoPandas-specific development practices and considerations

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jiayuasu jiayuasu added this to the sedona-1.8.0 milestone Aug 6, 2025
@jiayuasu jiayuasu merged commit e0dbd8a into apache:master Aug 6, 2025
8 checks passed
Kontinuation pushed a commit to Kontinuation/sedona that referenced this pull request Jan 21, 2026
* Add geopandas README.md

* Move docs to docs/community/geopandas and add entry to mkdocs.yml

* Update docs/community/geopandas.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/community/geopandas.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Update docs/community/geopandas.md

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Add example of spark explain output

* Move explain query plans section below rest of section

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Jia Yu <jiayu@wherobots.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Geopandas Developer Guide README.md

2 participants