Skip to content

Commit

Permalink
docs: Add workflow to publish documentation (#1040)
Browse files Browse the repository at this point in the history
* add docs workflow

* update some references to Apache Arrow
  • Loading branch information
andygrove authored Jul 13, 2024
1 parent 249d0e1 commit 62b2b90
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .asf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
81 changes: 81 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/source/_templates/layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</div>
{% endfor %}
<div class="footer-item">
<p>Apache Arrow Ballista, Arrow Ballista, Apache, the Apache feather logo, and the Apache Arrow Ballista project logo</p>
<p>Apache DataFusion Ballista, Arrow Ballista, Apache, the Apache feather logo, and the Apache DataFusion Ballista project logo</p>
<p>are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/source/community/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

# -- Project information -----------------------------------------------------

project = 'Apache Arrow Ballista'
project = 'Apache DataFusion Ballista'
copyright = '2019-2024, Apache Software Foundation'
author = 'Apache Software Foundation'

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contributors-guide/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
.. under the License.
=====================
Apache Arrow Ballista
Apache DataFusion Ballista
=====================

Table of content
Expand Down
5 changes: 1 addition & 4 deletions docs/source/user-guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 62b2b90

Please sign in to comment.