Apache Asyncband (Incubating) Website

Clone this repo:
  1. 3d641f9 chore(deps): consolidate updates and group Dependabot pull requests (#40) by tison · 8 hours ago main
  2. be1a75e docs: update downloads for 0.8.0 (#39) by Yijun Zhao · 26 hours ago
  3. e86b8f4 ci: clean up previews when source branches are deleted (#37) by tison · 2 days ago
  4. 1e16fa3 chore(deps): bump body-parser from 1.20.6 to 1.20.9 (#30) by dependabot[bot] · 5 days ago
  5. a560d6f chore(deps): bump launch-editor from 2.14.1 to 2.14.2 (#31) by dependabot[bot] · 5 days ago

Apache Asyncband (Incubating) Website

This repository contains the source for the Apache Asyncband (Incubating) website. Read the project DISCLAIMER and learn what incubation means.

Developing

Install dependencies and start the Docusaurus development server:

pnpm install
pnpm dev

The local site is available at http://localhost:3000/ by default.

Writing documentation

Pages live under src/pages/. The homepage is src/pages/index.tsx, with its prose content in src/pages/_home-content.md. Markdown pages start with frontmatter for their title and metadata; the rest of the file is Markdown.

Fenced bash and rust code blocks are highlighted during the build. Docusaurus also supports MDX components when a page needs behavior beyond Markdown.

Run pnpm format to format the repository.

Writing blog posts

Blog posts live under blog/, with author profiles in blog/authors.yml. Keep avatar source URLs in image_url; the blog plugin fetches and embeds them during each build to comply with the ASF Content Security Policy. Failed downloads stop the build.

Validating

Run the type, formatting, lint, and production-build checks:

pnpm validate

Building and previewing

Generate the static site and preview the result locally:

pnpm build
pnpm preview

The generated site is written to build/. Pushing to main builds and publishes the site through the asf-site branch.

The deployment workflow also rebuilds main daily to refresh avatars without a source change.

To publish a staging preview, push the site source to a branch named preview/<name> in this repository. The same deployment workflow publishes the build through site/<name>-staging, which ASF serves at https://asyncband-<name>.staged.apache.org/.

Deleting preview/<name> removes the generated site/<name>-staging branch. Source branches are deleted automatically after merging a pull request. Closing a pull request without merging keeps its preview available until you delete the source branch. The staged preview may remain reachable until ASF infrastructure prunes it.

License

Licensed under the Apache License, Version 2.0.