Commit graph

65 commits

Author SHA1 Message Date
Lenka Segura
1bce0145dc Add forge runner admin documentation
All checks were successful
/ test (pull_request) Successful in 19s
Signed-off-by: Lenka Segura <lsegura@redhat.com>
2026-05-29 12:28:57 +02:00
0c42e36682 Include pull_requests.adoc in nav file 2026-05-27 12:19:18 +00:00
4074590a42 remove working with pull requests 2026-05-27 12:19:18 +00:00
1ce8876911 Add page for How to use pull requests 2026-05-27 12:19:18 +00:00
8e153cc7d9 Add overview and screenshots structure 2026-05-27 12:19:18 +00:00
Lenka Segura
4e2c4c8b3c Add forge image generation docs
All checks were successful
/ test (pull_request) Successful in 19s
Signed-off-by: Lenka Segura <lsegura@redhat.com>
2026-05-27 12:09:50 +02:00
e1bce5e119 Update .forgejo/workflows/docs.yml 2026-05-26 07:49:52 +00:00
Peter Oliver
ec7a5aa3ea Link to Fedora Forge 2026-04-30 03:00:55 +00:00
fda216a713 Highlight how to request a new FAS group in Requesting a New Organization and/or Team
All checks were successful
/ test (pull_request) Successful in 22s
2026-04-29 10:23:18 +02:00
c4a833430d remove draft documentation warnings
All checks were successful
/ test (pull_request) Successful in 25s
Resolves: forge/forge#530

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2026-04-28 02:34:15 +00:00
e4e7212ce4 Update .forgejo/workflows/docs.yml 2026-04-28 02:33:55 +00:00
f914c7bd34 add docs CI in proper location 2026-04-28 02:32:02 +00:00
6b9537ee1a Delete .forgejo/workflows 2026-04-28 02:31:00 +00:00
4c1fe56d7a add CI for docs 2026-04-28 02:28:48 +00:00
ce32b6799e Add guide for openshift webhook
As we now have working triggers for openshift webhooks, let's document it.

Signed-off-by: Michal Konecny <mkonecny@redhat.com>
2026-04-09 09:48:22 +02:00
ac455983be Include documentation for Forgejo W2FM support
Signed-off-by: Akashdeep Dhar <akashdeep.dhar@gmail.com>
2026-04-02 12:10:04 +05:30
8b5b9c7e78 Clarify ACLs and role in Gitlab migration procedure 2026-03-06 14:19:37 +01:00
e8676cdfa7 Pagure migration doc: add follow-up checklist based on ours
As we (Quality team) were doing our migrations to Forge, we came
up with a checklist and some supplemental migration tools. This
adds a slightly tweaked version of the checklist to the migration
doc as we think it will be helpful for all other teams.

See quality/tickets#836
for the original.

Signed-off-by: Adam Williamson <awilliam@redhat.com>
2026-02-11 08:37:23 -08:00
c9c866f781 Add tip admonition for access token registration
For many users, clicking a single link is more intuitive than clicking through
a series of menus.
2026-02-02 10:21:12 +00:00
e8ab12fb9b http-auth: make access token instructions chronological
You need an access token before you can clone/push to the repository, so
it makes more sense for that section to be first
2026-02-02 10:21:12 +00:00
Hristo Marinov
aa289a67e0 pagure_repository.adoc: Update screenshots
Fixes: forge/forge#293

Signed-off-by: Hristo Marinov <hricky@mail.bg>
2026-02-02 10:19:17 +00:00
Hristo Marinov
e244527c35 pagure_repository.adoc: Update AsciiDoc syntax
Signed-off-by: Hristo Marinov <hricky@mail.bg>
2026-02-02 10:19:17 +00:00
87e382f001 Update modules/ROOT/pages/requesting_new_org_or_team.adoc 2026-01-29 08:15:17 +00:00
b295a2c9fc docs: Add git-credential-libsecret as secure credential helper option
- Add Option A (simple store) and Option B (libsecret) for credential helpers
- Recommend libsecret for secure storage in GNOME Keyring/KDE Wallet
- Add installation and configuration instructions for libsecret
- Clarify that Access Token should be used as password, not FAS password
- Add link to official Git credentials documentation
2025-12-16 19:24:57 +10:00
5883305cdf add document about configuring nonbot webhook
Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-11-17 17:42:33 +10:00
78d199b9af Update migrating issues deps script documentation.
Fixes the documentation clarifying what permissions to give the key.

also added note about how we can run the script for you using the
forgebot account.

Fixes #282

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-11-17 13:46:21 +10:00
e570eb397d fix incorrect procedure for enabling email notifications
Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-11-13 20:40:36 +10:00
d3c810f79e Move FAS group naming standards to user documentation
The naming standards document is more relevant for users who are requesting
organizations and teams, rather than being admin-specific documentation.
Placed it after the 'Requesting a New Organization and/or Team' document
for better logical flow.
2025-11-11 12:26:54 +10:00
fb276a4077 Fix inconsistent naming example in org/team request docs
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
2025-11-07 12:17:55 +10:00
5e9c1e761d Remove known issue documentation for user creation bug
The migrator bug that prevented users from being created properly has been
fixed. The workaround documentation and references are no longer needed.

Changes:
- Removed known_issue_cannot_create_user.adoc
- Removed reference from nav.adoc
- Removed reference from migration/pagure.adoc
2025-11-07 12:10:21 +10:00
4e838f2dbe Add document about email notifications
Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-11-03 17:03:30 +10:00
22e06bfcf3 Update docs to reference forge.fp.o/forge/forge rather than codeberg
Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-11-03 16:26:17 +10:00
f2b91d1212 Update admin SOPs with group mapping changes
fixes: https://codeberg.org/fedora/forgejo-deployment/issues/228

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-10-29 19:08:59 +10:00
3e14805572 Replace real usernames with fictional ones in email sync script sample output
- Change authenticated user from 'ryanlerch' to 'adminuser'
- Replace real usernames with fictional ones: dudemcpants, testermctesterson, fergieforge
- Use example.com and example.org domains instead of real email addresses
- Maintain educational value while protecting user privacy
- Sample still demonstrates all key script scenarios (successful updates, fasnotfound cases)
2025-10-28 13:23:00 +10:00
87fa8ed072 Add email sync doc 2025-10-28 09:28:38 +10:00
d6324ec303 Update README.md 2025-10-20 08:05:08 +00:00
827b557a91 Use “an” rather than “a” where applicable
Signed-off-by: Nils Philippsen <nils@redhat.com>
2025-10-10 13:19:21 +02:00
c063e7a0b8 Clarify Accounts vs. Forge, password vs. token
Fixes: https://codeberg.org/fedora/forgejo-deployment/issues/209

Signed-off-by: Nils Philippsen <nils@redhat.com>
2025-10-10 13:18:04 +02:00
eeed6a452b Add team membership management documentation
- Document how team membership is managed through Fedora Accounts groups
- Explain why Forgejo UI team management is not used
- Provide step-by-step instructions for managing team membership
- Include important note about logout/login requirement for changes
- Add to User Documentation navigation
2025-10-06 08:23:40 +10:00
ab125abc9b Add organizations and teams mapping documentation
- Document relationship between Organizations and Teams in Fedora Forge
- Explain mapping from Pagure.io concepts to Forgejo structure
- Provide Rust organization migration example with standard FAS group naming
- Link to FAS Group Naming Standards for exception cases
- Add to User Documentation navigation
2025-10-06 07:59:26 +10:00
c61c013efb Add Fedora Accounts groups and Forge team naming documentation
- Document Fedora Accounts groups, Forge organizations, and team naming
- Explain that owners team is mandatory (Forgejo requirement), not specifically the Fedora Accounts group
- Document flexible team naming with examples (docs teams: quick-docs-writers, etc.)
- Document organization naming (no fedora- prefix, no -sig suffix)
- Document examples for council, releng, and docs organizations
- Document exception cases for reusing existing groups like council
2025-10-06 07:30:18 +10:00
5a5d256af6 Add known issue documentation for organization projects
Documents issue #139 where adding repository issues to organization-level projects fails silently when the Projects unit is disabled at the repository level. Includes problem description, symptoms, root cause, workaround steps, and upstream status with links to bug report and fix PR.
2025-10-02 19:19:18 +10:00
cd8ac39727 Add Issue and Pull Request Templates documentation
Comprehensive guide covering:
- Creating issue templates with YAML front matter
- Creating pull request templates (single template per repo)
- Issue template configuration with blank_issues_enabled and contact_links
- Form-based YAML templates with link to official docs
- Troubleshooting common template issues
2025-10-02 18:50:42 +10:00
9757024d20 Update organization profile page documentation 2025-09-24 15:12:02 +10:00
ac753246c1 Abstract shared migration tool access section to reduce duplication
- Created shared include file: partials/access_fedora_forge_migration_tool.adoc
- Updated pagure_repository.adoc to use shared section via include
- Updated pagure_private_tickets.adoc to use shared section via include
- Removed outdated steps from private tickets document
- Both documents now use consistent, up-to-date migration tool access steps

This eliminates code duplication and ensures both migration documents
stay in sync when the shared steps need to be updated.

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-09-18 13:53:32 +10:00
5cacec1682 Rename Pagure migration images to descriptive filenames and crop screenshots
- Renamed migration_pagure_08.png to pagure_migration_new_migration_button.png
- Renamed migration_pagure_09.png to pagure_migration_select_pagure_source.png
- Renamed migration_pagure_10.png to pagure_migration_form_filled.png
- Renamed migration_pagure_11.png to pagure_migration_start_migration_button.png
- Renamed migration_pagure_12.png to pagure_migration_completion_success.png

- Cropped screenshots to remove empty space and unneeded bloat for cleaner documentation

Updated references in both pagure_repository.adoc and pagure_private_tickets.adoc
to use the new descriptive filenames that clearly indicate image content.

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-09-18 13:43:34 +10:00
fb09e72a31 Fix xref link paths in Pagure migration overview
- Fix xref:pagure_repository.adoc to xref:migration/pagure_repository.adoc
- Fix xref:pagure_private_tickets.adoc to xref:migration/pagure_private_tickets.adoc
- Fix xref:github.adoc to xref:migration/github.adoc
- Fix xref:gitlab.adoc to xref:migration/gitlab.adoc

Resolves AsciiDoc build errors for missing xref targets in pagure.adoc

Signed-off-by: Ryan Lerch <rlerch@redhat.com>
2025-09-18 11:13:03 +10:00
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
3e9b15c90d Split Pagure migration documentation and improve structure
- Split original Pagure migration doc into three documents:
  - Overview document with migration options
  - Standard repository migration guide
  - Private tickets migration guide
- Add draft documentation warnings to all migration docs
- Correct API key usage warnings (only needed for private tickets)
- Update navigation to group Pagure migration docs together
- Move issue dependencies migration under Pagure subsection
- Crop screenshots to remove unnecessary content
- Improve procedure formatting with headings and summaries
- Specify Pagure.io instance name for clarity
- Streamline API key creation steps with better instructions
2025-09-18 00:31:53 +10:00
c51d535130 Standardize documentation formatting and structure
- Fix heading levels across all documents (level 1 titles, level 2 sections)
- Convert procedure ordered lists to headings for better navigation
- Add procedure summaries to admin documentation
- Simplify ordered list formatting by removing unnecessary * formatting
- Update navigation to include new Pagure migration sub-documents

This improves consistency and usability across all Fedora Forge documentation.
2025-09-17 23:12:13 +10:00