quarkusio/quarkusio.github.io

Quarkus.io Website is the documentation and content site for the Quarkus project, built as a static site generated from HTML and served through GitHub Pages.

The site serves as the central hub for Quarkus documentation, guides, and blog content. It is built using a Maven-based development workflow with Quarkus itself, allowing developers to run the full site locally including all guides, or optionally run a faster version without guides or with only the latest guides. The site generation is handled by a tool called Roq, which processes the content and generates the complete site that gets deployed to GitHub Pages.

Anyone contributing to or maintaining this site needs Java 21 or later and Maven to run locally. The development setup is straightforward: cloning the repository and running a Maven command starts a dev server on port 8042. Initial startup takes a minute or two while dependencies download and the site generates, but subsequent starts are faster. For blog contributions, the project maintains an authors file and requests that human writers retain their voice and perspective rather than relying on generative AI to write entire posts, though AI assistance in writing is acceptable. Deployment happens automatically via GitHub Actions when commits reach the main branch, though local deployment is possible using the act tool if needed.

The project maintains active engagement with contributors through clear documentation of the contribution process. The README includes explicit guidance on blog writing standards and author registration procedures, indicating attention to content quality and contributor experience. Development activity shows responsiveness to maintaining the site infrastructure and documentation pipeline, with automated deployment workflows in place to keep the live site synchronized with repository changes.