This folder contains resources that build the Apache Hudi website
The site is based on a Jekyll theme hosted here with detailed instructions.
Simply run docker-compose build --no-cache && docker-compose up from the docs folder and the site should be up & running at http://localhost:4000
To see edits reflect on the site, you may have to bounce the container
- Stop existing container by
ctrl+cthe docker-compose program - (or) alternatively via
docker stop docs_server_1 - Bring up container again using
docker-compose up
To build directly on host OS (*nix), first you need to install
- gem, ruby (using apt-get/brew)
- bundler (
gem install bundler) - jekyll (
gem install jekyll) - Update bundler
bundle update --bundler
and then run the following commands from docs folder to install dependencies
bundle install
and serve a local site
bundle exec jekyll serve
To submit changes to the docs, please make the changes on the asf-site branch, build the site locally, test it out and submit a pull request with the changes to .md and theme files under docs
At a regular cadence, one of the Hudi committers will regenerate the site. In order to do this, first build it locally, test and then move the generated site from _site locally to docs/../content. Submit changes as a PR.
During each release, we must preserve the old version's docs so users on that version can refer to it. Below documents the steps needed to do that.
Copy the docs as-is into another folder
cd docs/_docs
export VERSION=0.5.0
mkdir -p $VERSION && cp *.md $VERSION/
This step changes the permalink (location where these pages would be placed) with a version prefix and also changes links to each other.
cd $VERSION
sed -i "s/permalink: \/docs\//permalink: \/docs\/${VERSION}-/g" *.md
sed -i "s/permalink: \/cn\/docs\//permalink: \/cn\/docs\/${VERSION}-/g" *.cn.md
sed -i "s/](\/docs\//](\/docs\/${VERSION}-/g" *.md
sed -i "s/](\/cn\/docs\//](\/cn\/docs\/${VERSION}-/g" *.cn.md
sed -i "0,/---/s//---\nversion: ${VERSION}/" *.md
In _config.yml, add a new author section similar to 0.5.0_author. Then, change quick_link.html with a if block to use this navigation, when the new version's page is rendered
{%- if page.language == "0.5.0" -%}
{%- assign author = site.0.5.0_author -%}
{%- else -%}
{%- assign author = site.author -%}
{%- endif -%}
Then in navigation.yml, add a new section similar to 0.5.0_docs (or the last release), with each link pointing to pages starting with $VERSION-. Change nav_list with else-if to
render the new version's equivalent navigation links.
{% if page.version %}
{% if page.version == "0.5.0" %}
{% assign navigation = site.data.navigation["0.5.0_docs"] %}
{% endif %}
{% endif %}