diff --git a/.asf.yaml b/.asf.yaml index aebf957d6..dae11d120 100644 --- a/.asf.yaml +++ b/.asf.yaml @@ -39,3 +39,8 @@ github: rebase: false features: issues: true +# publishes the content of the `asf-site` branch to +# https://datafusion.apache.org/ballista/ +publish: + whoami: asf-site + subdir: ballista \ No newline at end of file diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml new file mode 100644 index 000000000..257224f1e --- /dev/null +++ b/.github/workflows/docs.yaml @@ -0,0 +1,81 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +on: + push: + branches: + - main + paths: + - .asf.yaml + - .github/workflows/docs.yaml + - docs/** + +name: Deploy DataFusion Ballista site + +jobs: + build-docs: + name: Build docs + runs-on: ubuntu-latest + steps: + - name: Checkout docs sources + uses: actions/checkout@v4 + + - name: Checkout asf-site branch + uses: actions/checkout@v4 + with: + ref: asf-site + path: asf-site + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: "3.10" + + - name: Install dependencies + run: | + set -x + python3 -m venv venv + source venv/bin/activate + pip install -r docs/requirements.txt + + - name: Build docs + run: | + set -x + source venv/bin/activate + cd docs + ./build.sh + + - name: Copy & push the generated HTML + run: | + set -x + cd asf-site/ + rsync \ + -a \ + --delete \ + --exclude '/.git/' \ + ../docs/build/html/ \ + ./ + cp ../.asf.yaml . + touch .nojekyll + git status --porcelain + if [ "$(git status --porcelain)" != "" ]; then + git config user.name "github-actions[bot]" + git config user.email "github-actions[bot]@users.noreply.github.com" + git add --all + git commit -m 'Publish built docs triggered by ${{ github.sha }}' + git push || git push --force + fi \ No newline at end of file diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 101a49ab0..921dffaae 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -17,7 +17,7 @@ {% endfor %} diff --git a/docs/source/community/communication.md b/docs/source/community/communication.md index e13491920..baa27d8af 100644 --- a/docs/source/community/communication.md +++ b/docs/source/community/communication.md @@ -22,7 +22,7 @@ We welcome participation from everyone and encourage you to join us, ask questions, and get involved. -All participation in the Apache Arrow Ballista project is governed by the +All participation in the Apache DataFusion Ballista project is governed by the Apache Software Foundation's [code of conduct](https://www.apache.org/foundation/policies/conduct.html). @@ -38,7 +38,7 @@ coorindation and design discussions When emailing the dev list, please make sure to prefix the subject line with a `[Ballista]` tag, e.g. `"[Ballista] New API for remote data sources"`, so -that the appropriate people in the Apache Arrow community notice the message. +that the appropriate people in the Apache DataFusion community notice the message. ### Slack and Discord diff --git a/docs/source/conf.py b/docs/source/conf.py index ae2f03ebf..7a3477f80 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,7 +33,7 @@ # -- Project information ----------------------------------------------------- -project = 'Apache Arrow Ballista' +project = 'Apache DataFusion Ballista' copyright = '2019-2024, Apache Software Foundation' author = 'Apache Software Foundation' diff --git a/docs/source/contributors-guide/development.md b/docs/source/contributors-guide/development.md index e5bb1e4b1..a21595b10 100644 --- a/docs/source/contributors-guide/development.md +++ b/docs/source/contributors-guide/development.md @@ -22,7 +22,7 @@ We welcome participation from everyone and encourage you to join us, ask questions, and get involved. -All participation in the Apache Arrow Ballista project is governed by the +All participation in the Apache DataFusion Ballista project is governed by the Apache Software Foundation's [code of conduct](https://www.apache.org/foundation/policies/conduct.html). diff --git a/docs/source/index.rst b/docs/source/index.rst index 60e810b32..9491eccf5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,7 +16,7 @@ .. under the License. ===================== -Apache Arrow Ballista +Apache DataFusion Ballista ===================== Table of content diff --git a/docs/source/user-guide/faq.md b/docs/source/user-guide/faq.md index f96306c1c..5cfd9fe8b 100644 --- a/docs/source/user-guide/faq.md +++ b/docs/source/user-guide/faq.md @@ -19,10 +19,7 @@ # Frequently Asked Questions -## What is the relationship between Apache Arrow, DataFusion, and Ballista? - -Apache Arrow is a library which provides a standardized memory representation for columnar data. It also provides -"kernels" for performing common operations on this data. +## What is the relationship between DataFusion and Ballista? DataFusion is a library for executing queries in-process using the Apache Arrow memory model and computational kernels. It is designed to run within a single process, using threads