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.
This commit is contained in:
Ryan Lerch 2025-09-18 01:05:34 +10:00
commit 789bd278a3
8 changed files with 40 additions and 0 deletions

View file

@ -1,5 +1,10 @@
= Create a Custom Front Page for an Organization using a `.profile` Repository on Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This guide demonstrates how to leverage the special `.profile` repository feature in https://forge.fedoraproject.org[Fedora Forge] to display a custom Markdown-based front page directly on your organization's main profile page. This allows for a richer and more informative landing experience for your organization.

View file

@ -1,5 +1,10 @@
= How to Create a New Organization in Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document outlines the steps required to create a new

View file

@ -1,5 +1,10 @@
= How to Create a New Team in Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document outlines the steps required to create a new team within

View file

@ -2,6 +2,11 @@ include::partial$attributes.adoc[]
= Fedora Forge: Your Home for Fedora Collaboration
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
Welcome to Fedora Forge, the official home for Fedora teams, SIGs, and
subprojects. Built on the open-source Forgejo platform, Fedora Forge is a
dedicated space designed to streamline development and collaboration across the

View file

@ -1,5 +1,10 @@
= Known Issue: Unable to Log in - "Cannot Create Account"
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document explains a known issue with the Pagure migrator where user accounts are created but not properly enabled. The issue presents itself when an affected user attempts to log in to Fedora Forge. Instead of a successful login, the user receives an error message stating that they are unable to create their account and must contact a system administrator for assistance. This occurs because the user's account has been created by the migrator but has not been finalized in the same way as a new account created via the Forgejo UI.

View file

@ -2,6 +2,11 @@ include::partial$attributes.adoc[]
= Migrating Issue Dependencies and Assignments from Pagure.io to Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document provides a comprehensive guide for using the `assign_and_depend.py` script to restore issue dependencies and assignments after migrating a project from Pagure.io to Fedora Forge. The built-in migrator does not handle this critical metadata, making this script an essential post-migration step.

View file

@ -1,5 +1,10 @@
= Requesting a New Organization and/or Team in Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document outlines the standardized process for Fedora Project contributors

View file

@ -1,5 +1,10 @@
= How to Clone a Repository using HTTPS Authentication in Fedora Forge
[WARNING]
====
**DRAFT DOCUMENTATION:** This documentation is currently in draft form and may not be fully tested and correct. Please verify all procedures before use and report any issues or inaccuracies.
====
== Purpose
This document provides a step-by-step guide on how to clone a repository from