Technical Glossary

This glossary defines technical terms used throughout the Domus Digitalis documentation infrastructure.

Antora & Documentation

Antora

A static site generator designed specifically for creating documentation sites from AsciiDoc content stored in Git repositories. Supports multi-repo aggregation where multiple Git repositories contribute content to a single documentation site.

Antora Playbook

A YAML configuration file (antora-playbook.yml) that defines how Antora builds the documentation site. Specifies content sources (Git repos), UI bundle location, output directory, and extensions.

UI Bundle

A ZIP archive containing all the assets (HTML templates, CSS, JavaScript, images) that define how the documentation site looks and behaves. Antora applies this bundle to all generated pages.

Handlebars (.hbs)

A templating language used by Antora UI bundles. Files like header-content.hbs and footer-scripts.hbs are Handlebars partials that define reusable HTML fragments.

Partials

Reusable template fragments in Handlebars. Located in src/partials/ of a UI bundle. Common partials include:

  • header-content.hbs - Navigation bar structure

  • footer-scripts.hbs - JavaScript loading

  • head-styles.hbs - Early CSS and theme detection

AsciiDoc

A lightweight markup language for writing documentation. More powerful than Markdown, supporting features like cross-references (xref), includes, conditional content, and tables of contents.

Component

In Antora, a logical grouping of documentation (e.g., infra-ops, ise-linux). Each component has its own version, navigation, and can span multiple modules.

Aggregator

A repository that pulls content from multiple source repositories and combines them into a single documentation site. domus-docs is the aggregator for all domus-* repos.

Cloudflare & Security

Cloudflare Pages

A JAMstack platform for deploying static sites directly from Git repositories. Provides global CDN distribution, automatic HTTPS, and preview deployments for branches.

Cloudflare Access

A Zero Trust security layer that protects applications by requiring authentication before granting access. Part of Cloudflare Zero Trust suite.

Zero Trust

A security model that requires strict identity verification for every person and device trying to access resources, regardless of whether they are inside or outside the network perimeter.

Service Token

A credential pair (Client ID + Client Secret) used for machine-to-machine authentication with Cloudflare Access. Allows CI/CD pipelines and scripts to access protected resources without interactive login.

Access Application

A Cloudflare Access configuration that defines what resource to protect (domain/path) and what policies govern access. Example: antora-ui-bundle application protecting ui.domusdigitalis.dev.

Access Policy

Rules that determine who or what can access a Cloudflare Access application. Can include:

  • Email-based authentication

  • Identity provider groups

  • Service token authentication (for CI/CD)

  • IP ranges

Service Auth

A Cloudflare Access policy type that grants access to requests containing valid service token headers. Used for automated systems like CI/CD builds.

Web & UI Concepts

FOUC (Flash of Unstyled Content)

A brief moment where a web page displays with default styling before the intended CSS loads. Prevented in Antora UI by detecting and applying the theme in <head> before the page renders.

Cookie Persistence

Storing user preferences (like theme selection) in browser cookies so they persist across page loads and sessions. Example: antora-theme=dark cookie.

CDN (Content Delivery Network)

A geographically distributed network of servers that delivers web content from locations closest to users. Cloudflare Pages uses their global CDN for fast delivery.

Glassmorphism

A UI design style featuring frosted-glass effects, blur, and transparency. Used in theme toggle buttons in the Domus UI.

Build & Deployment

Gulp

A JavaScript task runner used to build the Antora UI bundle. Compiles CSS, bundles JavaScript, and creates the final ui-bundle.zip.

npm / Node.js

npm (Node Package Manager) manages JavaScript dependencies. Node.js is the JavaScript runtime. UI bundle builds require Node.js (v18+ for Cloudflare Pages compatibility).

CI/CD (Continuous Integration/Continuous Deployment)

Automated processes that build, test, and deploy code when changes are pushed to Git. Cloudflare Pages provides built-in CI/CD triggered by Git pushes.

Environment Variables

Configuration values set outside the code, used for secrets and environment-specific settings. Examples:

  • CF_ACCESS_CLIENT_ID - Service token ID

  • CF_ACCESS_CLIENT_SECRET - Service token secret

  • CF_ANTORA_GIT_TOKEN - GitHub PAT for private repos

Snapshot Bundle

A UI bundle marked with snapshot: true in the playbook, indicating Antora should always fetch a fresh copy instead of using cached versions.

Infrastructure Terms

Private Repository

A Git repository that requires authentication to access. domus-antora-ui is private to prevent unauthorized access to the UI source.

GitHub PAT (Personal Access Token)

A token that grants programmatic access to GitHub repositories. Used by Antora to fetch content from private domus-* repos during builds.

Custom Domain

A domain you own (like ui.domusdigitalis.dev) configured to point to a service like Cloudflare Pages, instead of using the default *.pages.dev domain.

Quick Reference

Term One-Line Definition

Antora

Static site generator for multi-repo documentation

UI Bundle

ZIP file containing all site styling and scripts

Handlebars

Templating language for HTML partials

Service Token

Machine-to-machine auth credential for CI/CD

Zero Trust

Security model requiring identity verification for all access

FOUC

Flash of unstyled content before CSS loads

Cloudflare Pages

Static site hosting with global CDN

Playbook

YAML config defining how Antora builds the site