This website is built using Docusaurus, a modern static website generator.

• Node.js version 20.0 or above (which can be checked by running node -v). You can use nvm for managing multiple Node versions on a single machine installed.
  • When installing Node.js, you are recommended to check all checkboxes related to dependencies.

npm install

To preview only the current development version of the docs (i.e. docs/ on your local branch), without any versioned docs or blog:

npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Note: This mode does not include versioned docs or blog content. The version dropdown in the navbar will only show the Next version.

To preview the full website locally with all released versioned docs and blog posts, you need to run the following setup scripts before building.

This script clones the remote repository, checks out each release-x.y branch, and copies their website/docs/ into versioned_docs/. It also generates versions.json and versioned sidebar files.

bash build_versioned_docs.sh

This may take a few minutes as it clones the full repository. After completion, you will see:

• versioned_docs/version-x.y/ directories for each release
• versioned_sidebars/version-x.y-sidebars.json files
• An updated versions.json

Blog posts are maintained in a separate repository (apache/fluss-blog). This script clones it and places the blog/ directory into website/blog/.

bash setup_blog.sh

You can customize the blog source using environment variables:

# Use a different repo or branch
BLOG_REPO=https://github.com/<your-fork>/fluss-blog.git BLOG_BRANCH=my-branch bash setup_blog.sh

Note: If blog/ already exists, the script will automatically remove it and re-clone the latest content.

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Using SSH:

USE_SSH=true npm run deploy

Not using SSH:

GIT_USER=<Your GitHub username> npm run deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.