Source for the Apache Sourcelume website.
The site is a static Pelican site, built by the ASF
infrastructure from this repository via .asf.yaml (the pelican: block builds
main and publishes the generated HTML to the asf-site branch, which is served at
sourcelume.apache.org). Content is written in Markdown with Mermaid diagram support.
content/
pages/ Markdown pages (one file per page)
theme/ Pelican theme (templates)
css/ js/ fonts/ highlight/ images/ static assets
pelicanconf.py Pelican configuration (Python)
pelicanconf.yaml
.asf.yaml ASF infrastructure configuration (build + notifications)
pyproject.toml Python dependencies (managed with uv)
- Pages live in
content/pages/*.md. Each page starts with a short metadata block (Title:andlicense:); the home page also setsTemplate: index. - New pages appear automatically; add them to the navigation in
content/theme/templates/menu.html. - Changes go through a pull request (fork, branch, PR) - for small fixes, GitHub's pencil icon on a file is a quick way to start one straight from the file view.
- Note when making any substantive changes run
make checkbefore committing. This will surface any potential CI/CD failures in your PR.
The authoritative build runs on ASF infrastructure. To preview locally you need the ASF
Pelican plugins (asfgenid, asfrun, gfm, …) provided by
apache/infrastructure-pelican; see
that project for setup.
Any branch in this repository that is named preview/* will auto-build and stage to sourcelume-*.staged.apache.org.
If you need to test your changes, create a branch such as preview/<your-asf-id>.
Commits to it will be staged at sourcelume-<your-asf-id>.staged.apache.org.
Note
The branch name must not include any "." characters, or browsers will refuse to display the site due to an invalid SSL certificate. The underscore character ("_") should not be used either, as it is disallowed in host names.
- Mailing list: dev@sourcelume.apache.org (archives)
- ASF Slack: #sourcelume (Ask to be invited)
This project is licensed under Apache License, Version 2.0.