Skip to content

Commit d38bcc3

Browse files
skrawczskrawcz
authored
Big update to docs and repo -- adds apache related concerns
This adds a bunch of apache related changes. To publish docs we need to publish via the ASF preferred mechanism. This hopefully sets things up. Adds headers to fall files. Changes references where needed. E.g. Burr -> Apache Burr; updates domains. Changes adds to .asf adds to .github workflows updates docs & references. adds headers to all files update base URL add ASF footer add ASF links update docs for ASF guidelines -- e.g. Apache Burr vs Burr remove / fix video on front page due to not allowing images from other
1 parent da39a36 commit d38bcc3

File tree

448 files changed

+8196
-183
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

448 files changed

+8196
-183
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Bug report
3-
about: Create a bug report to help us improve Burr.
3+
about: Create a bug report to help us improve Apache Burr.
44
title: Bug Report
55
labels: triage
66
assignees: ''

‎.github/workflows/docs.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
#<!--
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#-->
119
name: documentation
220

321
on:

‎.github/workflows/python-package.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
#<!--
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#-->
119
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
220
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
321

‎.github/workflows/sphinx-docs.yml‎

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
#<!--
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#-->
19+
name: Build Sphinx Documentation
20+
21+
on:
22+
push:
23+
branches: [ "main", "update_references"]
24+
paths:
25+
- 'docs/**'
26+
- '.github/workflows/sphinx-docs.yml'
27+
pull_request:
28+
branches: [ "main", "update_references" ]
29+
paths:
30+
- 'docs/**'
31+
- '.github/workflows/sphinx-docs.yml'
32+
workflow_dispatch:
33+
34+
concurrency:
35+
group: "doc-pages"
36+
cancel-in-progress: true
37+
38+
jobs:
39+
build-docs:
40+
runs-on: ubuntu-latest
41+
42+
steps:
43+
- uses: actions/checkout@v4
44+
with:
45+
fetch-depth: 0
46+
47+
- name: Set up Python 3.12
48+
uses: actions/setup-python@v5
49+
with:
50+
python-version: '3.12'
51+
cache: 'pip'
52+
53+
- name: Install system dependencies
54+
run: |
55+
sudo apt-get update
56+
sudo apt-get install -y graphviz
57+
58+
- name: Upgrade pip and setuptools
59+
run: |
60+
python -m pip install --upgrade --no-cache-dir pip setuptools
61+
62+
- name: Install Sphinx and dependencies
63+
run: |
64+
python -m pip install --upgrade --no-cache-dir sphinx sphinx-rtd-theme sphinx-simplepdf
65+
# python -m pip install --group documentation --upgrade --upgrade-strategy only-if-needed --no-cache-dir
66+
pip install -e ".[documentation]"
67+
68+
- name: Build Sphinx documentation
69+
working-directory: ./docs
70+
run: |
71+
# sphinx-build docs -b dirhtml _build
72+
python -m sphinx -T -W --keep-going -b dirhtml -d _build/doctrees -D language=en . _build/html
73+
74+
- name: Upload HTML artifact
75+
uses: actions/upload-artifact@v4
76+
with:
77+
name: sphinx-docs-html
78+
path: docs/_build/html/
79+
retention-days: 5
80+
81+
- name: Upload PDF artifact
82+
uses: actions/upload-artifact@v4
83+
with:
84+
name: sphinx-docs-pdf
85+
path: docs/_build/pdf/
86+
retention-days: 5
87+
88+
- name: Deploy documentation
89+
working-directory: ./docs
90+
run: |
91+
# Set target branch based on current branch
92+
if [ "${{ github.ref }}" = "refs/heads/main" ]; then
93+
TARGET_BRANCH="asf-site"
94+
echo "Deploying to production (asf-site) branch"
95+
else
96+
TARGET_BRANCH="asf-staging"
97+
echo "Deploying to staging (asf-staging) branch"
98+
fi
99+
100+
# Configure git
101+
git config --global user.name "GitHub Actions"
102+
git config --global user.email "actions@github.com"
103+
104+
# Create a temporary directory
105+
mkdir -p /tmp/gh-pages
106+
107+
# Store current directory
108+
CURRENT_DIR=$(pwd)
109+
ls -lsa $CURRENT_DIR
110+
111+
# Try to clone the repository with the target branch
112+
if ! git clone --branch $TARGET_BRANCH --single-branch \
113+
https://github.com/${{ github.repository }}.git /tmp/gh-pages 2>/dev/null; then
114+
# If branch doesn't exist, initialize a new repository and create the branch
115+
echo "Branch $TARGET_BRANCH doesn't exist. Creating it..."
116+
rm -rf /tmp/gh-pages
117+
mkdir -p /tmp/gh-pages
118+
cd /tmp/gh-pages
119+
git init
120+
git config --local init.defaultBranch $TARGET_BRANCH
121+
git checkout -b $TARGET_BRANCH
122+
git remote add origin https://github.com/${{ github.repository }}.git
123+
cd "$CURRENT_DIR"
124+
else
125+
echo "CD'ing into $CURRENT_DIR"
126+
cd "$CURRENT_DIR"
127+
fi
128+
129+
# Remove existing content directory if it exists
130+
rm -rf /tmp/gh-pages/content
131+
132+
# # Ensure build directories exist
133+
# mkdir -p "$CURRENT_DIR/_build/html"
134+
135+
# Copy the built HTML documentation to the content directory
136+
mkdir -p /tmp/gh-pages/content
137+
cp -r "$CURRENT_DIR/_build/html/"* /tmp/gh-pages/content/ 2>/dev/null || echo "No HTML files to copy"
138+
139+
# Add, commit and push the changes
140+
cd /tmp/gh-pages
141+
git status
142+
ls -lhsa content
143+
# Create a README if it doesn't exist
144+
if [ ! -f README.md ]; then
145+
echo "# Documentation for $TARGET_BRANCH" > README.md
146+
echo "This branch contains the built documentation." >> README.md
147+
fi
148+
git add -A
149+
git status
150+
# Check if there are changes to commit (including untracked files)
151+
if [ -n "$(git status --porcelain)" ]; then
152+
git commit -m "Deploy documentation from ${{ github.sha }}"
153+
git push https://x-access-token:${{ github.token }}@github.com/${{ github.repository }}.git $TARGET_BRANCH
154+
echo "Changes pushed to $TARGET_BRANCH branch"
155+
else
156+
echo "No changes to deploy"
157+
fi

‎.github/workflows/ui.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
#<!--
2+
# Licensed to the Apache Software Foundation (ASF) under one
3+
# or more contributor license agreements. See the NOTICE file
4+
# distributed with this work for additional information
5+
# regarding copyright ownership. The ASF licenses this file
6+
# to you under the Apache License, Version 2.0 (the
7+
# "License"); you may not use this file except in compliance
8+
# with the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing,
13+
# software distributed under the License is distributed on an
14+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
# KIND, either express or implied. See the License for the
16+
# specific language governing permissions and limitations
17+
# under the License.
18+
#-->
119
name: Node.js CI
220

321
on:

‎CONTRIBUTING.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Developer notes
3030
CLI
3131
---
3232

33-
Burr comes with a `cli` that is both user/developer facing.
33+
Apache Burr comes with a `cli` that is both user/developer facing.
3434

3535
**this is required in order to publish, do not do so otherwise**
3636

0 commit comments

Comments
 (0)