diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index ed3d92c4cb..2abf245ecd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -3,19 +3,13 @@ on: push: branches: - master - paths: - - 'docs/**' - - 'docs-overrides/**' - - 'mkdocs.yml' - - 'R/**' + pull_request: branches: - '*' - paths: - - 'docs/**' - - 'docs-overrides/**' - - 'mkdocs.yml' - - 'R/**' + +env: + MAVEN_OPTS: -Dmaven.wagon.httpconnectionManager.ttlSeconds=60 jobs: build: @@ -24,6 +18,14 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 + - name: Set up Java + uses: actions/setup-java@v1 + with: + java-version: '8' + - name: Compile JavaDoc + run: mvn -q clean install -DskipTests && mkdir -p docs/api/javadoc/spark && cp -r spark/common/target/apidocs/* docs/api/javadoc/spark/ + - name: Compile ScalaDoc + run: mvn scala:doc && mkdir -p docs/api/scaladoc/spark && cp -r spark/common/target/site/scaladocs/* docs/api/scaladoc/spark - uses: actions/setup-python@v5 with: python-version: 3.x @@ -44,19 +46,28 @@ jobs: any::pkgdown working-directory : './R' - run: Rscript -e 'pkgdown::build_site(pkg = "./R", preview = FALSE, override = list(destination = "../docs/api/rdocs"))' - - uses: actions/cache@v3 - with: - path: ~/.cache/pip - key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} - restore-keys: | - ${{ runner.os }}-pip- - - - run: git config --global user.name = "test-name" - - run: git config --global user.email = "test-email@abc.com" - - run: mike deploy --update-aliases current-snapshot + - run: git config --global user.name = "GitHub Action" + - run: git config --global user.email = "test@abc.com" + - run: mkdocs build + - name: Deploy the doc to the website branch + if: ${{ github.event_name != 'pull_request' }} + run: mike deploy latest-snapshot -b website -p - run: mkdir staging - run: cp -r site/* staging/ - uses: actions/upload-artifact@v3 with: name: generated-docs path: staging + - name: Cache Python packages + uses: actions/cache@v3 + with: + path: ~/.cache/pip + key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} + restore-keys: | + ${{ runner.os }}-pip- + - name: Cache Maven packages + uses: actions/cache@v3 + with: + path: ~/.m2 + key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }} + restore-keys: ${{ runner.os }}-m2 diff --git a/README.md b/README.md index 4430f25af3..bb14a45f8b 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Follow Sedona on Twitter for fresh news: [Sedona@Twitter](https://twitter.com/ApacheSedona) -Join the Sedona Discord community: [![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://sedona.apache.org/latest/community/contact/#discord-server) +Join the Sedona Discord community: [![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) Join the Sedona monthly community office hour: [Google Calendar](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NjI0cWgwcTZndnI1anAzYnFrNHY5Y2wyaTRfMjAyNDA0MDlUMTUwMDAwWiBjX2VmN2Q1NGY1MzA4YTRiN2YyNWFjMzNkMGY3ZWViNTRhM2E3ZjExNWI2ODlmYWY0ZDgyNDI1ZjNjYjVlZGU5MzVAZw&tmsrc=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&scp=ALL), Tuesdays from 8 AM to 9 AM Pacific Time, every 4 weeks diff --git a/docs/community/contact.md b/docs/community/contact.md index 11f6fa3f13..85113df466 100644 --- a/docs/community/contact.md +++ b/docs/community/contact.md @@ -11,9 +11,7 @@ You can participate in the community as follows: ## Community events -Everyone is welcome to join our community events. We have a community office hour every 4 weeks. - - +Everyone is welcome to join our community events. We have a community office hour every 4 weeks. Please import the event to your [Google Calendar](https://calendar.google.com/calendar/event?action=TEMPLATE&tmeid=NjI0cWgwcTZndnI1anAzYnFrNHY5Y2wyaTRfMjAyNDA0MDlUMTUwMDAwWiBjX2VmN2Q1NGY1MzA4YTRiN2YyNWFjMzNkMGY3ZWViNTRhM2E3ZjExNWI2ODlmYWY0ZDgyNDI1ZjNjYjVlZGU5MzVAZw&tmsrc=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&scp=ALL). ## Twitter @@ -21,18 +19,7 @@ Everyone is welcome to join our community events. We have a community office hou ## Discord Server -![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY) - -Fill in the form below to join the Sedona Discord Server! - - - +[![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q) ## Mailing list diff --git a/docs/community/contributor.md b/docs/community/contributor.md index 50bcafa80f..e2b2033a13 100644 --- a/docs/community/contributor.md +++ b/docs/community/contributor.md @@ -47,6 +47,7 @@ Current Sedona Committers are as follows: | Name | GitHub ID | Apache ID | |:-----------------:|:-----------:|:----------------------:| | Nilesh Gajwani | iGN5117 | nilesh@apache.org | +| Furqaan Khan | furqaankhan | furqaan@apache.org | ## Nominate a committer or PMC member diff --git a/docs/usecases/airport-country.md b/docs/usecases/airport-country.md deleted file mode 100644 index b3ae2d14a1..0000000000 --- a/docs/usecases/airport-country.md +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/usecases/foot-traffic.md b/docs/usecases/foot-traffic.md deleted file mode 100644 index f98e970e57..0000000000 --- a/docs/usecases/foot-traffic.md +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/usecases/raster.md b/docs/usecases/raster.md deleted file mode 100644 index 5d4e3b4b84..0000000000 --- a/docs/usecases/raster.md +++ /dev/null @@ -1 +0,0 @@ - diff --git a/docs/usecases/usecases.md b/docs/usecases/usecases.md new file mode 100644 index 0000000000..e69de29bb2 diff --git a/mkdocs.yml b/mkdocs.yml index 3f48ae9390..841f618a8d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -110,9 +110,10 @@ nav: - Vote a release: community/vote.md - Publications: community/publication.md - Use cases: - - Spatially aggregate airports per country: usecases/airport-country.md - - Match foot traffic to Seattle coffee shops: usecases/foot-traffic.md - - Raster image manipulation: usecases/raster.md + - Use cases: usecases/usecases.md + - Spatially aggregate airports per country: https://nbviewer.org/github/apache/sedona/blob/master/binder/ApacheSedonaSQL_SpatialJoin_AirportsPerCountry.ipynb" target="_blank + - Match foot traffic to Seattle coffee shops: https://nbviewer.org/github/jiayuasu/sigspatial-2021-cafe-analysis/blob/master/notebooks/Workshop_example.ipynb" target="_blank + - Raster image manipulation: https://nbviewer.org/github/johnymontana/raster-data-analysis-spatial-sql/blob/main/00-raster-data-analysis.ipynb" target="_blank - Apache Software Foundation: - Foundation: asf/asf.md - License: https://www.apache.org/licenses/" target="_blank