Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS][CI] Auto push docs to the website branch #1305

Merged
merged 15 commits into from
Apr 3, 2024
51 changes: 31 additions & 20 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 2 additions & 15 deletions docs/community/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,15 @@ 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.

<iframe src="https://calendar.google.com/calendar/embed?src=c_ef7d54f5308a4b7f25ac33d0f7eeb54a3a7f115b689faf4d82425f3cb5ede935%40group.calendar.google.com&ctz=America%2FLos_Angeles" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
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

[Apache Sedona@Twitter](https://twitter.com/ApacheSedona)

## Discord Server

![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)

Fill in the form below to join the Sedona Discord Server!

<script charset="utf-8" type="text/javascript" src="//js.hsforms.net/forms/embed/v2.js"></script>
<script>
hbspt.forms.create({
region: "na1",
portalId: "44429642",
formId: "4af794ab-318a-4d3b-ae8b-50143dbbdca5"
});
</script>
[![](https://dcbadge.vercel.app/api/server/9A3k5dEBsY)](https://share.hsforms.com/1Ndql_ZigTdmLlVQc_d1o4gqga4q)

## Mailing list

Expand Down
1 change: 1 addition & 0 deletions docs/community/contributor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion docs/usecases/airport-country.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/usecases/foot-traffic.md

This file was deleted.

1 change: 0 additions & 1 deletion docs/usecases/raster.md

This file was deleted.

Empty file added docs/usecases/usecases.md
Empty file.
7 changes: 4 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading