https://github.com/apache/arrow-site
Mirror of Apache Arrow site
https://github.com/apache/arrow-site
arrow
Last synced: 6 months ago
JSON representation
Mirror of Apache Arrow site
- Host: GitHub
- URL: https://github.com/apache/arrow-site
- Owner: apache
- License: apache-2.0
- Created: 2016-02-17T08:00:06.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-04-22T00:32:52.000Z (6 months ago)
- Last Synced: 2025-04-22T10:33:12.348Z (6 months ago)
- Topics: arrow
- Language: HTML
- Size: 2.52 GB
- Stars: 38
- Watchers: 32
- Forks: 112
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Security: security.md
Awesome Lists containing this project
README
# Apache Arrow Website
## Overview
[Jekyll](https://jekyllrb.com/) is used to generate HTML files from the
Markdown + templates in this repository. The built version of the site is kept
on the `asf-site` branch, which gets deployed to https://arrow.apache.org.
## Adding Content
To add a blog post, create a new markdown file in the `_posts` directory,
following the model of existing posts. In the front matter, you should specify
an "author". This should be your Apache ID if you have one, or it can just be
your name. To add additional metadata about yourself (GitHub ID, website), add
yourself to `_data/contributors.yml`. This object is keyed by `apacheId`, so
use that as the `author` in your post. (It doesn't matter if the ID actually
exists in the ASF; all metadata is local to this project.)
## Prerequisites
With a recent version of [Ruby](https://www.ruby-lang.org/) (i.e. one that does not have
an [End-Of-Life (EOL) status](https://www.ruby-lang.org/en/downloads/branches/)) installed,
run the following commands to install [Jekyll](https://jekyllrb.com/).
```shell
gem install bundler
bundle install
```
We also need [Node.JS](https://nodejs.org/) to use
[webpack](https://webpack.js.org/) for maintaining dependent
JavaScript and CSS libraries.
We can install webpack and dependent JavaScript and CSS libraries
automatically by following command lines to preview or build the site. So
we just need to install Node.JS here.
## Previewing the site
Run the following and open http://localhost:4000/ to preview generated
site locally:
```shell
bundle exec rake
```
## Deployment
### apache/arrow-site
On a commit to the `main` branch of `apache/arrow-site`, the rendered
static site will be published to the `asf-site` branch using GitHub
Actions.
### Forks
When implementing changes to the website on a fork, the GitHub Actions
workflow behaves differently.
On a commit to the `main` branch, the rendered static site will be
published to a branch named `gh-pages` (rather than `asf-site`). If it doesn't
already exist, a `gh-pages` branch will be automatically created by the
GitHub Actions workflow when it succeeds.
The **gh**-**p**ages branch is intended to be used with **G**it**H**ub **P**ages.
Deploying changes on the `gh-pages` branch to GitHub Pages is a useful way to
preview changes to the website. It can also be a helpful way to share changes
that are still in progress with others, since they can easily view them
by navigating to the GitHub Pages URL in their web browser.
For the changes on the `gh-pages` branch to be deployed to GitHub Pages,
the *Source* branch for GitHub Pages deployment must be set to `gh-pages`
in the repository Settings of your fork (by default, the Source branch
should be set to `asf-site`). Instructions on how to configure
the Source branch can be found in the [GitHub Pages documentation](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-from-a-branch).
FYI: We can also generate the site for https://arrow.apache.org/
to `_site/` locally by the following command line:
```shell
JEKYLL_ENV=production bundle exec rake generate
```
## Using Docker Compose
If you don't wish to change or install `ruby` and `nodejs` locally,
you can use Docker Compose to build and preview the site with a command like:
```shell
docker compose up
```
Then open http://localhost:4000 locally.