Commit graph

243 commits

Author SHA1 Message Date
8040332093
chore: make docsbuilder script executable 2026-05-29 12:02:15 +01:00
06735c0070
chore: update docsbuilder script 2026-05-29 12:00:53 +01:00
a110d892f4 Copr documentation moved to docs.copr.fedorainfracloud.org
See https://github.com/fedora-copr/copr/pull/4198
2026-03-30 15:07:10 +02:00
Patrik Polakovič
73c218a812 Update RelEng-related URLs
Signed-off-by: Patrik Polakovič <patrik@alphamail.org>
2025-12-12 15:54:14 +01:00
357eb771f8 Simple typo in Tutorial_1. 2025-08-04 19:08:47 +02:00
8d10c1a161 Fix EPEL retirement link typo 2025-07-16 08:55:27 -05:00
c10f9fae9f Use docopt syntax more consistently
There are many places in Package Maintainer Docs that document or give
examples of command line tool syntax. Most of these were already using
notation that was compatible, or almost so, with [docopt]. Be more
consistent by making everything really compatible with that notation,
and also by choosing to denote a mandatory parameter via <some_string>
instead of SOME_STRING.

[docopt]: http://docopt.org/
2025-06-29 13:27:22 +00:00
7c94449fc0 Pull Request Guide: Fix 'fedpkg mockbuild' invocation
The preceding instructions ask to create a branch for the build
request. Consequently, `--release rawhide` is needed for fedpkg.
2025-04-12 23:32:53 +03:00
729ae0c991 Update year and Fedora release number attributes
As these are updates very irregularly and Fedora 41 was almost
completely missed, and with Fedora 42 release being just days away, set
MAJOROSVER to 42 now.
2025-04-12 23:25:11 +03:00
fa488b94d2 Fix broken attempt at resolving to current Fedora release 2025-04-12 23:13:17 +03:00
3dbcca3902 Package Maintenance Guide: Improve writing of "Upload new source files to the lookaside cache" 2025-04-12 22:40:30 +03:00
Dennis van Raaij
0e503ae3b1 Clarify the need for a Kerberos ticket for uploading source files 2025-04-12 22:40:29 +03:00
fbfce809a7 Installing Packager Tools: Add link to 2FA setup instructions 2025-04-12 15:08:17 +03:00
378ca81181
fix: quote addrepo args
Otherwise `$basearch` gets expanded by the shell
2025-04-08 16:02:49 +01:00
e5efa4f3ae
fix: add -- to command
Since it needs to be passed to mock itself.
2025-03-06 10:29:41 +00:00
0cac97c16f
feat: add how to mockbuild using a side tag
Ref:
https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/message/AHN7TMK4MKEX4DWJOSV2DXAAVYIQ5SSY/
2025-03-05 21:39:13 +00:00
b93abf3484 Maintenance: advise retirement of rawhide branch for epel-only packages
As discussed in https://pagure.io/fesco/issue/3345.
2025-02-19 06:41:30 -05:00
2be4f859c4 Installing Packager Tools: Remove explicit fedora-review install
`fedora-review` is now Recommended by `fedora-packager` [1], so it will
get automatically installed as a dependency. There is no need to
explicitly mention it any more.

[1]: https://src.fedoraproject.org/rpms/fedora-packager/pull-request/10
2025-01-29 00:08:53 +02:00
f43c57ca89 Package Update Guide: Check for dependents with fedrq
Previously, `fedrq` was only mentioned in the Utilities page. On the
other hand, Package Update Guide did not have anything about checking
for affected dependents. Move `fedrq` usage instructions to that page,
so it is part of a document describing a full workflow, rather than
just in a list of random tools.

The new _Finding dependents_ section in Package Update Guide is quite
short for such a complicated topic. It can be extended later. The
purpose of this change is not to exhaustively cover that topic. The
purpose is just to move the existing coverage of `fedrq` abd checking
for affected packages.
2025-01-28 22:03:01 +00:00
cb9670a8db Package update guide: add --request to koji wait-repo call
Add --request to the recommended koji wait-repo call for doing
side tag builds, needed now we use on-demand repo generation.

Signed-off-by: Adam Williamson <awilliam@redhat.com>
2025-01-28 10:00:55 -08:00
ba64aa79fa Fix typos and improve grammar in Pull Request Guide 2024-12-31 01:09:15 +02:00
fedcef7adf Fix formatting in Installing Packager Tools
The following items were broken in [pull request 173][pr]:

* Section was in the wrong level.

* String '<=' was intended to be interpreted as-is, but Antora actually
  replaces this sequence with the '⇐' character.

* Delimiters for code blocks were wrong and were interpreted as
  horizontal lines.

[pr]: https://pagure.io/fedora-docs/package-maintainer-docs/pull-request/173
2024-12-30 23:44:16 +02:00
7c748e59b0 Small adjustments to New Package Process for New Contributors
Just small cleanup after [pull request 172][pr].

[pr]: https://pagure.io/fedora-docs/package-maintainer-docs/pull-request/172
2024-12-30 23:28:07 +02:00
6ade090e49 Update modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc
Adjusted the contribution based on suggestions in the comments
2024-12-30 12:43:57 +00:00
1caa4fe876 Update modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc
Slightly changed the writing of the upload the source section
2024-12-30 12:43:57 +00:00
420c35ed22 Update modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc
Adjusted with semantic line breaks,
I have moved the text introducing copr as an option from section upload your package, but have not changed it's wording or syntax
2024-12-30 12:43:57 +00:00
dc86e65975 Update modules/ROOT/pages/New_Package_Process_for_New_Contributors.adoc
Added a short step by step guide how to use Corp for new contributors
2024-12-30 12:43:57 +00:00
Hong Xu
675ca1ce51 Explain the consequence of using git index version 2 by default 2024-12-29 21:58:33 +00:00
Hong Xu
af31d3c040 New line for every period 2024-12-29 21:54:20 +00:00
Hong Xu
42abe3ded6 Add an example tool 2024-12-26 08:08:46 +00:00
Hong Xu
f14cb4ab0c Grammar fixes 2024-12-21 21:46:24 +00:00
Hong Xu
d39227d0b8 Document that git index version must be <= 2 2024-12-21 21:43:50 +00:00
John Schmidt
f54a20b0e0 Update modules/ROOT/pages/Packaging_Tutorial_1_banner.adoc
This rpm --query command was missing the correct version number for the directory under results_banner
2024-11-28 17:45:11 +00:00
John Schmidt
83a8f8d39d Update modules/ROOT/pages/Packaging_Tutorial_1_banner.adoc
The readme file is just README, not README.md
2024-11-28 17:39:41 +00:00
35d89db8c2 Update modules/ROOT/pages/Package_Maintenance_Guide.adoc
Drop references to stream branches and package.cfg
2024-10-25 13:58:33 +00:00
3555aa16d8 Utilities: add fbrnch
Add a section about the fbrnch packaging tool
2024-08-14 09:13:18 +00:00
ba6d7b28f0 Remove duplicate instructions for requesting branches
Requesting dist-git branches was covered in multiple places. To avoid
maintaining the same information in multiple places, retain one
location, extend it with additional information from other places, and
replace other places with links.

This is a follow up for f0316f9347 from #165 where the new location,
intended to be the main source, was added.
2024-08-13 09:24:59 +00:00
b142317734 Update modules/ROOT/pages/Packaging_Tutorial_1_banner.adoc 2024-08-05 07:53:05 +00:00
f0316f9347 Add instructions for requesting branches to the Package Maintenance Guide 2024-07-26 16:37:55 -05:00
8c5ea8b5c0 Package Update Guide: Move _Update attributes_ section to higher level
Section _Update attributes_ was under the section about singe-package
updates, but its content applies equally to multi-package updates.
Move it to correct level in the section hierarchy.
2024-07-19 17:38:11 +03:00
afe1fc2749 Package Update Guide: Fix section levels
Some sections were put under section _Multi-package updates_, even
though they applied equally to single-package updates. Move them to
higher level to avoid confusion and make the table of contents easier
to understand.
2024-07-19 17:38:03 +03:00
1b7d059a7b Package Update Guide: Give names to different update workflows
Previously, the different workflows used before and after
updates-testing activation did not have clear names. Instead, they were
referred to by explaining the difference every time, with quite many
words. Simplify the text by naming them _before updates-testing activation_
and _after updates-testing_activation_.
2024-07-19 17:35:56 +03:00
52fb85df60 Add Pull Request Guide
Pull requests are an important aspect of how Fedora packaging works,
and, crucially, the easiest way for new contributors to get started.
Document a way how they can be used.

Fixes #66
2024-07-04 22:07:56 +03:00
e044d4c4b9 Replace mention of _master_ branch with its primary name _main_ 2024-07-04 21:39:42 +03:00
e3fc9e1a0f Replace builder.sh with newer docsbuilder.sh
The script comes from [fedora-docs-template][1], which already a long
time ago released a new version. And also changed script name. Update
to match upstream, and to benefit from new features and fixes, whatever
they may be.

[1]: https://gitlab.com/fedora/docs/templates/fedora-docs-template
2024-07-04 21:39:42 +03:00
379152348f Fix many link-checker.sh warnings and errors
The most common warning is about redirects. Such links are replaced
with direct links. In some cases better syntax for the same URL is
used, and in a single case the link target seems to be completely gone,
so the link is just removed.
2024-07-04 21:39:42 +03:00
7033af84d6 Replace Wiki links that already redirected to Fedora Docs
Redirects show unnecessary warnings in `check-links.sh` output, and
using the Wiki for anything documentation related should be avoided.
2024-07-04 21:39:42 +03:00
a1287f0c49 Use https instead of http in links
This is the modern way, and also removes many warnings from
`check-links.sh` output.
2024-07-04 21:39:42 +03:00
a34a137860 Improve check-links.sh
1. linkchecker had removed option `--complete`, so have to remove it
   from here as well.

2. Many errors were not actionable, because they came from Docs
   stylesheet. Add `--ignore-url` entries to silence such errors.
2024-07-04 21:39:42 +03:00
f56a2a9181 Remove unneeded scripts
Both build.sh and preview.sh have been replaced with builder.sh,
and already did nothing but return a removal notice.
2024-07-04 21:39:42 +03:00