t0xic0der/forge-documentation
1
0
Fork 0
forked from forge/documentation
Code Pull requests Activity
Documentation for Fedora Forge
18 commits 5 branches 0 tags 25 MiB
  • Shell 100%
Find a file
Ryan Lerch 789bd278a3 Add draft documentation warnings to all documentation files 
- Add consistent draft warning to all non-migration documentation
- Warn users that documentation is in draft form and may not be fully tested
- Encourage users to verify procedures before use
- Request feedback on issues or inaccuracies
- Ensure consistent user experience across all documentation

This provides transparency about the current development status of the
Fedora Forge documentation and helps manage user expectations.
2025-09-18 01:05:34 +10:00
modules/ROOT Add draft documentation warnings to all documentation files 2025-09-18 01:05:34 +10:00
.gitignore Initial Import from Fedora Docs Template 2025-09-08 15:39:12 +10:00
.gitlab-ci.yml Initial Import from Fedora Docs Template 2025-09-08 15:39:12 +10:00
antora.yml Remove boilerplate, add first content 2025-09-08 16:27:06 +10:00
docsbuilder.sh Initial Import from Fedora Docs Template 2025-09-08 15:39:12 +10:00
LICENSE Initial Import from Fedora Docs Template 2025-09-08 15:39:12 +10:00
nginx.conf Initial Import from Fedora Docs Template 2025-09-08 15:39:12 +10:00
README.md Update README with documentation overview and Fedora Forge-specific wording 2025-09-15 18:13:21 +10:00
site.yml Remove boilerplate, add first content 2025-09-08 16:27:06 +10:00

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 and teams
  • 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