Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
# Contributing to this repo

Build and test your changes locally according to the instructions in [README](../README.md).

Once you've done that, submit a pull request with your changes. You only need to commit your changes to the Markdown source. A GitHub Actions workflow will [generate the corresponding HTML and push it for you](./workflows/html-push.yml).
Make sure that you generate site HTML with `jekyll build`, and include the changes to the HTML in your pull request also. See README.md for more information.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<!-- *Make sure that you generate site HTML with `bundle exec jekyll build`, and include the changes to the HTML in your pull request. See README.md for more information.* -->
21 changes: 0 additions & 21 deletions .github/actions/build-html/action.yml

This file was deleted.

76 changes: 76 additions & 0 deletions .github/workflows/doc_gen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Check document generation

on:
push:
branches:
- asf-site
pull_request:
branches:
- asf-site

jobs:
lint:
name: check whether all documentation was generated with the right Jekyll version
runs-on: ubuntu-24.04
steps:
- name: Free up disk space
shell: 'script -q -e -c "bash {0}"'
run: |
echo "=================================="
echo "Free up disk space on CI system"
echo "=================================="

echo "Listing top 100 largest packages (from large to small)"
printf "Installed-Size\tPackage\n"
dpkg-query -Wf '${Installed-Size}\t${Package}\n' | sort -n -r | head -n 100
df -h

echo "Removing large packages"
rm -rf /__t/CodeQL
rm -rf /__t/go
rm -rf /__t/node

apt-get remove --purge -y '^aspnet.*' || true
apt-get remove --purge -y '^dotnet-.*' || true
apt-get remove --purge -y '^llvm-.*' || true
apt-get remove --purge -y 'php.*' || true
apt-get remove --purge -y '^mongodb-.*' || true
apt-get remove --purge -y 'gfortran-11' || true
apt-get remove --purge -y 'humanity-icon-theme' || true
apt-get remove --purge -y 'nodejs-doc' || true
apt-get remove --purge -y snapd google-chrome-stable microsoft-edge-stable firefox || true
apt-get remove --purge -y azure-cli google-cloud-sdk mono-devel powershell libgl1-mesa-dri || true
apt-get autoremove --purge -y
apt-get clean

df -h
- name: Checkout Spark Website repository
uses: actions/checkout@v2
- name: Install dependencies for documentation generation
run: |
sudo apt-get update -y
sudo apt-get install -y ruby ruby-dev
sudo gem install bundler --version 2.4.19
bundle install
- name: Run documentation build
run: |
export LC_ALL=C.UTF-8
export LANG=C.UTF-8
OLD_IFS=$IFS
IFS=
GEN_ERRORS=$(bundle exec jekyll build 3>&2 2>&1 1>&3)
if [ $(echo $GEN_ERRORS| grep -v -e '^$'| grep -c -v "rubygems_integration") -ne 0 ]; then
echo "Error during document generation:"
echo $GEN_ERRORS
exit 1
fi
IFS=$OLD_IFS
CHANGED_FILE=( $(git ls-files --modified --other --exclude-standard --directory | grep -v sitemap.xml | grep -v llms.txt) )
if [ ${#CHANGED_FILE[@]} -ne 0 ]; then
echo "Not all documentation was generated and/or not the right Jekyll version was used! Modified / untracked files (excluding sitemap.xml):"
echo ${CHANGED_FILE[*]}
echo "Git diff (excluding sitemap.xml):"
git diff -- . ':(exclude)site/sitemap.xml'
exit 1
fi
shell: /bin/bash {0}
16 changes: 0 additions & 16 deletions .github/workflows/html-build.yml

This file was deleted.

43 changes: 0 additions & 43 deletions .github/workflows/html-push.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ target/
.jekyll-cache/
.jekyll-metadata
.local_ruby_bundle
site/
site/python
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,4 @@
# Apache Spark Main Website

This repository captures the main Apache Spark website located at https://spark.apache.org. The programming docs are [in the main Spark repo][1], not here.

[1]: https://github.com/apache/spark/tree/master/docs

To contribute changes, see [CONTRIBUTING](.github/CONTRIBUTING.md).

## Generating the website HTML locally
## Generating the website HTML

In this directory you will find text files formatted using Markdown, with an `.md` suffix.

Expand Down Expand Up @@ -36,6 +28,22 @@ of Spark from the Spark source repository and then copied to the website under t
directory. See the instructions for building those in the readme in the Spark
project's `/docs` directory.

## Rouge and Pygments

We also use [Rouge](https://github.com/rouge-ruby/rouge) for syntax highlighting in documentation Markdown pages.
Its HTML output is compatible with CSS files designed for [Pygments](https://pygments.org/).

To mark a block of code in your Markdown to be syntax highlighted by `jekyll` during the
compile phase, use the following syntax:

{% highlight scala %}
// Your Scala code goes here, you can replace Scala with many other
// supported languages too.
{% endhighlight %}

You probably don't need to install that unless you want to regenerate the Pygments CSS file.
It requires Python, and can be installed by running `sudo easy_install Pygments`.

## Merge PR

To merge a pull request, use the `merge_pr.py` script. This script also squashes the commits.
To merge pull request, use the `merge_pr.py` script which also squashes the commits.
2 changes: 1 addition & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ kramdown:
entity_output: symbol
permalink: none
destination: site
exclude: ['README.md', 'LICENSE', 'merge_pr.py', 'Gemfile', 'Gemfile.lock']
exclude: ['README.md', 'content', 'LICENSE', 'merge_pr.py', 'Gemfile', 'Gemfile.lock']
keep_files: ['docs', 'static', 'llms.txt']
url: https://spark.apache.org
1 change: 1 addition & 0 deletions content
39 changes: 21 additions & 18 deletions site/sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1163,10 +1163,7 @@
<loc>https://spark.apache.org/releases/spark-release-0-3.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/</loc>
<changefreq>weekly</changefreq>
</url>

<url>
<loc>https://spark.apache.org/404.html</loc>
<changefreq>weekly</changefreq>
Expand Down Expand Up @@ -1208,65 +1205,70 @@
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/graphx/</loc>
<loc>https://spark.apache.org/history.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/history.html</loc>
<loc>https://spark.apache.org/improvement-proposals.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/improvement-proposals.html</loc>
<loc>https://spark.apache.org/spark-connect/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/mailing-lists.html</loc>
<loc>https://spark.apache.org/pandas-on-spark/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/graphx/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/mllib/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/news/</loc>
<loc>https://spark.apache.org/streaming/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/pandas-on-spark/</loc>
<loc>https://spark.apache.org/news/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/powered-by.html</loc>
<loc>https://spark.apache.org/screencasts/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/release-process.html</loc>
<loc>https://spark.apache.org/sql/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/research.html</loc>
<loc>https://spark.apache.org/</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/screencasts/</loc>
<loc>https://spark.apache.org/mailing-lists.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/security.html</loc>
<loc>https://spark.apache.org/powered-by.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/spark-connect/</loc>
<loc>https://spark.apache.org/release-process.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/sql/</loc>
<loc>https://spark.apache.org/research.html</loc>
<changefreq>weekly</changefreq>
</url>
<url>
<loc>https://spark.apache.org/streaming/</loc>
<loc>https://spark.apache.org/security.html</loc>
<changefreq>weekly</changefreq>
</url>

<url>
<loc>https://spark.apache.org/third-party-projects.html</loc>
<changefreq>weekly</changefreq>
Expand All @@ -1279,4 +1281,5 @@
<loc>https://spark.apache.org/versioning-policy.html</loc>
<changefreq>weekly</changefreq>
</url>

</urlset>
15 changes: 3 additions & 12 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -151,18 +151,9 @@ sitemap: false
<changefreq>weekly</changefreq>
</url>
{% endfor %}
{%- comment -%}
Explicitly sort `site.pages` so that the order is consistent and we don't get spurious git diffs.
`site.posts` doesn't have this issue because it's already sorted.
See: https://jekyllrb.com/docs/variables/#site-variables
{%- endcomment -%}
{%- assign sorted_pages = site.pages | sort: "url" -%}
{%- for page in sorted_pages -%}
{%- if page.sitemap != false -%}
<url>
{% for page in site.pages %}{% if page.sitemap != false %}<url>
<loc>{{ site.url }}{{ page.url }}</loc>
<changefreq>weekly</changefreq>
</url>
{% endif %}
{%- endfor -%}
</url>{% endif %}
{% endfor %}
</urlset>
Loading