documentation/README.md

Fedora Forge Documentation

The official Fedora Forge documentation is available at: https://docs.fedoraproject.org/en-US/forge-documentation/

This repository contains the source documentation for Fedora Forge, the official collaboration platform for Fedora teams, SIGs, and subprojects. The documentation covers:

• User Documentation: Guides for creating organization front pages, requesting new organizations and teams, and using HTTPS authentication.
• Admin Documentation: Procedures for creating new organizations, teams, runners, OCI image build pipeline.
• Migration Guides: Step-by-step instructions for migrating projects from Pagure.io to Fedora Forge, including restoring issue dependencies and assignments.
• Known Issues: Workarounds for common problems encountered on Fedora Forge.

Local preview

This repository includes a script to build and preview the Fedora Forge documentation locally.

NOTE: Please note that if you reference pages from other Fedora documentation repositories, such links will be broken in this local preview as it only builds the Fedora Forge documentation repository.

The script works on Fedora (using Podman or Docker).

To build and preview the site, run:

$ ./docsbuilder.sh -p

The result will be available at http://localhost:8080

To stop the preview:

$ ./docsbuilder.sh -k

Installing Podman on Fedora

Fedora Workstation doesn't come with Podman preinstalled by default — so you might need to install it using the following command:

$ sudo dnf install podman

License

SPDX-License-Identifier: CC-BY-SA-4.0