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>
- 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
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>
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.
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
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
- 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)
- 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
- 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
- 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
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.
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
- 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>
- 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>
- 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>
- 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.
- 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
- 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.
- Remove top 80 pixels containing browser UI elements from all migration screenshots
- Process 41 screenshots total (12 Pagure, 18 GitHub, 11 GitLab)
- Reduce image dimensions from 960x1050 to 960x970 pixels
- Clean up images to focus on actual content being documented
- Expand automated workaround section with detailed installation and usage instructions
- Update dependencies from API-based to Selenium web automation packages
- Add browser setup requirements and Firefox installation instructions
- Include detailed explanation of how the update_users.py script works
- Correct Fedora group name from sysadmin-main to sysadmin-forge
- Add important notes about manual login and processing requirements
- Add new documentation page for assign_and_depend.py script usage
- Cover installation, configuration, and usage with practical examples
- Include virtual environment setup and security best practices
- Update navigation to include the new migration guide
- Address critical post-migration step for restoring issue assignments and dependencies
- Add detailed description of repository contents including user docs, admin docs, migration guides, and known issues
- Update local preview section to use Fedora Forge-specific terminology instead of generic repository language
- Add link to official published documentation at docs.fedoraproject.org
- Remove outdated section about building whole Fedora Docs site locally
- Remove user_docs.adoc and admin_docs.adoc stub files
- Update navigation to use plain section headings instead of stub file links
- Maintain same navigation structure with cleaner implementation
- Add known_issue_cannot_create_user.adoc with comprehensive documentation
- Document manual and automated workarounds for affected user accounts
- Add link to fedora-infrastructure ticket tracker for reporting issues
- Update navigation to include new 'Known Issues' section
Resolves: https://codeberg.org/fedora/forgejo-deployment/issues/162
This commit migrates five documents from the old Markdown-based wiki at
https://codeberg.org/fedora/fedoraforge_documentation/wiki to this
new AsciiDoc-based documentation.
The following documents were migrated:
- How to create an Organization Front Page
- How to Clone a Repository using HTTPS Authentication in Fedora Forge
- Creating a new Organization
- Creating a new Team
- Requesting a New Organization and/or Team
https://gitlab.com/fedora/docs/templates/fedora-docs-template
Initial Commit
switch to Antora
Preview of the whole site
preview.sh: Allow preview.sh keep running for multiple build.sh calls
antora deletes and recreates public/ every time the docs are rebuilt;
mounting public/ directly meant that when build.sh, the existing nginx
container didn't see the new docs. Instead of mounting public/ directly
into the nginx default webroot, mount the parent directory at /antora,
and install a tiny nginx configuration file to point the webroot at the
right place.
fix preview.sh for macOS
Issue 3 - Check if sudo is really required to run docker
Provide better messages on the command line
deduplicate and in build.sh
Use podman as an option for local build/preview docs
The podman binary is an alternative to docker that might be used
by some people in preference. In this use case it's a drop in
replacement, we can just check for it, else we just use docker
as before.
Signed-off-by: Peter Robinson <pbrobinson@gmail.com>
using podman on Fedora — root not required anymore
Add workaround for --directory flag breaking in preview.sh script
Closes#13.
authors example
Add LICENSE
It's oven not owen
Replace test == operator with =
The == operator of test (invoked as [) is a Bash extension.
Use the = operator of [POSIX test] for string equality.
[POSIX test]: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/test.html
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Quote command substitution which may have spaces
If $(pwd) or $(uname -s) contain spaces, their output will undergo word
splitting and be passed as multiple arguments, which would cause the
programs receiving them to misbehave. Avoid this by quoting.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
Fix misspellings
build.sh: fix misspelling and replace tab with spaces
Some lines had tabs, others had spaces. Uniformizing for spaces.
Add proper partials and examples directories with usage notes
Fix typo in README
Update build script for Aarch64 and local antora installs
Fix if conditions in build.sh
Earlier comment removed quotation from around command substitions $().
This is not a good idea,
because if the substitution produces whitespace,
without the quotes, the result is not interpreted as a single string.
Pattern 'if [ $(uname) == "foo" ]'
is replaced with 'uname | grep -iwq foo' here.
Apart from following good shell scripting practices,
this commit fixes the problem where the script failed
if the current working directory's patch contained whitespace.
Fix the Linux docker branch of build.sh
There were multiple problems in the Linux docker branch of build.sh:
- Intendation was wrong
- There was a reference to undefined variable $runtime,
leading to corrupted output.
- Output had strange linebreaks.
Fix intendation in build.sh error branch
Use `version: ~` in antora.yml
Antora 3 has deprecated `version: master`.
Replacing it with a current alternative.
Update configuration for Antora 3.0
Whitespace and formating cleanup
build.sh: Properly quote all variables
Fix overquoting for ${cmd}
Fixes:
```
$ ./build.sh
This build script is using Podman to run the build in an isolated environment.
antora: option '--html-url-extension-style <choice>' argument 'indexify site.yml' is invalid. Allowed choices are default, drop, indexify.
```
update antora playbook
add preview pages
remove indexify extension from args
build.sh: Fix overquoting again
Missed in 7d3a02b
add content related issue template
update antora config & CI workflow
Update and correct licensing information
site.yaml: Use indexify mode for URLs
Official Fedora docs use that extension thus keep using it for local
preview.
Fixes: https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/4
This reworks commit bca134e1c05d93db7acecacdfefc4afabd8a1223.
Improve .gitignore
The intent of existing .gitignore was to ignore some directories
at repository root.
Instead, it was ignoring any file or directory by given names,
anywhere in the tree.
Improve rules to only match the intended cases.
feat: add new builder script
feat(docsbuilder.sh): add MIT license
Fixes https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/issues/5
docsbuilder: chmod a+x
Update README.md with docsbuilder command
Adding podman to the description.
docsbuilder: Use command to find binaries in PATH
Do not assume that commands are installed in a specific PATH and use
`command` instead to find them. This makes running this inside toolbox
works.
README: Re-add nginx.conf and update for osbuilder script
Use custom Antora image
