- Shell 100%
| modules/ROOT | ||
| releases | ||
| .gitignore | ||
| AGENTS.md | ||
| antora.yml | ||
| docsbuilder.sh | ||
| LICENSE.txt | ||
| nginx.conf | ||
| README.md | ||
| site.yml | ||
Fedora Program Operations Documentation
This repository contains the source documentation for Fedora Program Operations. It covers operational guidelines, schedules, and program processes maintained by the Fedora Operations Architect.
👥 Maintainers & Contact
Primary Owner: Fedora Operations Architect
| Status | Details |
|---|---|
| Current Maintainer | Aoife Moloney |
| Availability Note | ⚠️ On Maternity Leave until May 18th. |
| Interim Contact | Please reach out to the Fedora Project Leader or file an issue in this repository for urgent matters during this absence. |
📘 Documentation Scope
This documentation focuses on:
- Program Management: Schedules, releases, and election timelines.
- Operations: Logic regarding the day-to-day operations of the Fedora Project.
- Processes: Change management and strategic planning documentation.
🛠 Building the Docs Locally
This project uses Antora to build the documentation site. The structure follows standard Fedora Docs guidelines.
Prerequisites
You need podman (on Fedora/Linux) or docker (on macOS/Windows) to build the site locally.
Quick Start
To build and preview the site in one step, run:
$ ./docsbuilder.sh
The result will be available at localhost:8080.
Repository Structure
|-- antora.yml ....................... Metadata definition
|-- build.sh ......................... Local build script (uses container)
|-- preview.sh ....................... Local preview script (uses container)
|-- site.yml ......................... Playbook for the build script
`-- modules
`-- ROOT
|-- assets/images ............ Static images
|-- nav.adoc ................. Sidebar navigation menu
`-- pages .................... The actual .adoc content files
Full Build (Fedora Docs Context)
To preview your changes within the context of the entire Fedora Docs website (checking cross-references), you must clone the main build repository.
- Clone the build repo:
git clone [https://pagure.io/fedora-docs/docs-fp-o.git](https://pagure.io/fedora-docs/docs-fp-o.git)
cd docs-fp-o
-
Modify
site.ymlin that repo to point to your local version of the operations docs (or your fork on Forgejo). -
Build the full site:
./docsbuilder.sh
Legal
All Fedora Documentation content available under CC BY-SA 4.0 or, when specifically noted, under another accepted free and open content license.