How erickramirezau/cassandra-website works
This repository supports building and presenting the Apache Cassandra website: Antora combines site content, a UI bundle, and versioned Cassandra documentation into rendered HTML, which visitors use through the site UI. The tree and README establish that build flow, but most of the Antora configuration and content sources are not included here. The sampled Go tool is a deprecated, separate generator for native-protocol specification pages.
Main entry points: site-content Site content · site_yaml_generator.py Site YAML generator · main.go Protocol HTML generator · js Browser interactions
Components 16
Site generation
- Site content
site-content - Site YAML generator
site-content/bin/site_yaml_generator.py - Rendered website
Website experience
- UI bundle
site-ui - Browser interactions
site-ui/src/js - Template helpers
site-ui/src/helpers - AsciiDoc tabs
site-content/lib/tabs-block.js
Protocol docs
- Protocol HTML generator
cqlprotodoc/main.go - Specification parser
cqlprotodoc/spec/spec.go - Protocol HTML pages
Other components
- Content authors
- Release download page
- Antora
- Cassandra versioned docs
- Website visitor
- Protocol spec files
Connections 15
- Content authors → Site content: edit content
- Site content → Site YAML generator: provide settings
- Site YAML generator → Release download page: fetch versions
- Site YAML generator → Site content: write site YAML
- Site content → Antora: provide content
- UI bundle → Antora: style with
- Cassandra versioned docs → Antora: provide versions
- Antora → Rendered website: render pages
- Rendered website → Website visitor: serve website
- Website visitor → Browser interactions: use controls
- Browser interactions → Template helpers: use page helpers
- Site content → AsciiDoc tabs: extend AsciiDoc
- Protocol spec files → Protocol HTML generator: read versions
- Protocol HTML generator → Specification parser: parse specifications
- Protocol HTML generator → Protocol HTML pages: render pages