This repository contains the source code for https://parquet.apache.org/

This website is built / powered by Hugo with the Docsy Theme.

The following steps assume that you have hugo installed and working. You can also use docker, see the Docker section for more information.

Clone this repository to run the website locally:

git clone [email protected]:apache/parquet-site.git
cd parquet-site
git submodule update --init --recursive

To build or update CSS resources, you also need PostCSS to create the final assets. By default npm installs tools under the directory where you run npm install.

npm install -D autoprefixer
npm install -D postcss-cli
npm install -D postcss

To preview this website locally, run the following in the root of the directory:

hugo server

To build the metadata svg diagrams, you need mermaid.js installed. You can install it using npm:

npm install -D @mermaid-js/mermaid-cli

Then you can build the diagrams using the following command:

cd static/images
npx mmdc -i FileMetaData.mermaid -o FileMetaData.svg
npx mmdc -i PageHeader.mermaid -o PageHeader.svg

If you don't want to install hugo and its dependencies on your local machine, you can use docker. To do so, checkout the parquet-site repo as explained above and then use Dockerfile to build an image with the required tools:

docker build -t parquet-site .

Then run the container mounting the current directory to /parquet-site and exposing local port 1313:

docker run -it -v `pwd`:/parquet-site -p 1313:1313  parquet-site

Once inside the container, run the following to preview the site:

# Install necessary npm modules in parquet-site directory
cd parquet-site
npm install -D autoprefixer
npm install -D postcss-cli
npm install -D postcss
hugo server --bind 0.0.0.0 # run the server

You can now preview the site locally on http://localhost:1313/

To create documentation for a new release of parquet-format create a new .md file under content/en/blog/parquet-format. Please see existing files in that directory as an example.

To create documentation for a new release of parquet-java create a new .md file under content/en/blog/parquet-java. Please see existing files in that directory as an example.

To make a change to the staging version of the website:

1. Make a PR against the staging branch in the repository
2. Once the PR is merged, the Build and Deploy Parquet Site job in the deployment workflow will be run, populating the asf-staging branch on this repo with the necessary files.

Do not directly edit the asf-staging branch of this repo

To make a change to the production version of the website:

1. Make a PR against the production branch in the repository
2. Once the PR is merged, the Build and Deploy Parquet Site job in the deployment workflow will be run, populating the asf-site branch on this repo with the necessary files.

Do not directly edit the asf-site branch of this repo