t0xic0der/forge-documentation
1
0
Fork 0
forked from forge/documentation
Code Pull requests Activity

Fix inconsistent naming example in org/team request docs

Browse source 
Changed example organization name from 'myawesomesig' to 'infra' to be
consistent with naming standards that discourage using '-sig' suffix in
organization names.

Updated all example text to use 'Fedora Infrastructure Team' as a more
realistic and clear example throughout the documentation.

Fixes: forge/forge#271
Reported-by: Gordon Messmer
This commit is contained in:
Ryan Lerch 2025-11-07 12:14:39 +10:00
commit fb276a4077
1 changed files with 21 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

41
modules/ROOT/pages/requesting_new_org_or_team.adoc
View file

@ -50,17 +50,17 @@ If you are requesting a *new organization*, include the following information in
your ticket:
==== Desired Organization Name (Short Name)
This will be the short URL component for your organization (e.g., `forge.fedoraproject.org/org/myawesomesig`). It should be unique, lowercase, and typically hyphen-separated.
This will be the short URL component for your organization (e.g., `forge.fedoraproject.org/infra`). It should be unique, lowercase, and typically hyphen-separated.
====
`myawesomesig`
`infra`
====
==== Full Name of Organization
This is the human-readable, full name of your organization that will appear in the UI.
====
`My Awesome Special Interest Group`
`Fedora Infrastructure Team`
====
==== Description of Organization's Purpose
@ -68,28 +68,29 @@ A brief description of your organization's purpose or mission.
====
`This organization will host repositories and manage collaboration
for the My Awesome SIG, focusing on [briefly describe focus].`
for the Fedora Infrastructure Team, focusing on infrastructure
automation and tooling.`
====
==== Website URL *(Optional)*
An optional URL to a website for your organization.
====
`https://fedoraproject.org/wiki/My_Awesome_SIG`
`https://fedoraproject.org/wiki/Infrastructure`
====
==== Avatar/Logo *(Optional)*
An optional link to an image file for your organization's avatar/logo. You can also state that you will provide one later.
====
`https://fedoraproject.org/wiki/My_Awesome_SIG/logo.png`
`https://fedoraproject.org/wiki/Infrastructure/logo.png`
====
==== Fedora Accounts Group for Organization Owners
Specify the existing Fedora Accounts group whose members will automatically become the `Owners` of this new organization. The "Owners" team is a special, immutable team with full administrative control over the organization.
====
`forge-myawesomesig-owners`
`forge-infra-owners`
====
[IMPORTANT]
@ -106,7 +107,7 @@ team:
* **Target Organization Name:**
====
`myawesomesig` (if part of a new org request) or
`infra` (if part of a new org request) or
`existing-fedora-org` (if adding to an existing org).
====
@ -140,7 +141,7 @@ Choose one of: `Read`, `Write`, `Admin`.
**This is critical.** Specify the existing Fedora Accounts group
whose members will automatically be added to this new team in Forgejo.
`forge-myawesomesig-members` (ensure this Fedora Accounts group already exists).
`forge-infra-members` (ensure this Fedora Accounts group already exists).
====
* **Include all repositories? (Yes/No):**
@ -168,7 +169,7 @@ filling in the bracketed information.
[source,text]
----
Subject: [Forgejo] New Organization and Teams Request: My Awesome SIG
Subject: [Forgejo] New Organization and Teams Request: Fedora Infrastructure Team
----
Body:
@ -181,26 +182,26 @@ teams in Fedora Forge.
1. New Organization Details:
Desired Organization Name (Short Name): myawesomesig
Desired Organization Name (Short Name): infra
Full Name of Organization: My Awesome Special Interest Group
Full Name of Organization: Fedora Infrastructure Team
Description of Organization's Purpose: This organization will host repositories
and manage collaboration for the My Awesome SIG, focusing on developing and
maintaining [specific software/project].
and manage collaboration for the Fedora Infrastructure Team, focusing on
infrastructure automation and tooling.
Website URL (Optional): https://fedoraproject.org/wiki/My_Awesome_SIG
Website URL (Optional): https://fedoraproject.org/wiki/Infrastructure
Avatar/Logo (Optional): (Will provide a link to an image file later / No avatar
at this time)
Fedora Accounts Group for Organization Owners: forge-myawesomesig-owners
Fedora Accounts Group for Organization Owners: forge-infra-owners
2. New Team Details (within 'myawesomesig' organization):
2. New Team Details (within 'infra' organization):
Team 1:
Target Organization Name: myawesomesig
Target Organization Name: infra
Team Name: members
@ -209,10 +210,10 @@ repository management.
Desired Permission Level in Forgejo: Write
Fedora Accounts Group to Map to Team: forge-myawesomesig-members
Fedora Accounts Group to Map to Team: forge-infra-members
Include all repositories?: Yes (This team should have write access to all
current and future repositories in 'myawesomesig'.)
current and future repositories in 'infra'.)
Please let me know if any further information is required.