Te Creating RPM packages URL broke recently on the https://docs.fedoraproject.org/en-US/packaging-guidelines/ page (the breaking change being in this commit: https://pagure.io/fedora-docs/package-maintainer-docs/c/e9c53785442355c6fbed11c8aaedf12953090269?branch=main [1]) , and it seems to be caused by the :page-aliases: attribute in the document.
Creating RPM packages
:page-aliases:
I was going to submit a PR with this commit, however, I'm not a package maintainer, and I don't believe it's intended I submit a PR and get added to the membership group.
Due to technical issues, the packager group from the Fedora Account System cannot be granted access, so there is a dedicated Pagure group package-maintainer-docs with commit access. Membership is granted to authors of all merged pull request. Membership can also be requested by commenting on issue #23.
So here is an issue report :).
[1] It seems Antora parses the last instance of :page-aliases:, not all instances of them in the document. I did a quick test, and it is the case. https://docs.antora.org/antora/latest/page/page-aliases/#page-aliases-and-bulk-url-redirects
Howdy Cody!
You definitely should be able to submit a PR without being in the packager group. That note you found was about write access, i.e. committing directly or merging PRs.
The fix itself is a good catch, but I actually think we should take a slightly different approach. Instead of just fixing the double alias in Packaging_Tutorial_2_GNU_Hello.adoc, I think we should move the quick-docs::creating-rpm-packages.adoc alias to Packaging_Tutorial_1_banner.adoc. That is based on the commit description that introduced the banner tutorial, which intends to make that the introductory point for users. I'll leave this open for comment from other docs maintainers for a bit to see if they agree or not.
Packaging_Tutorial_2_GNU_Hello.adoc
quick-docs::creating-rpm-packages.adoc
Packaging_Tutorial_1_banner.adoc
After that is in place we should also look at updating the packaging guidelines to point directly to the new link instead of relying on the alias.
Hello! Anybody can definitely submit a pull request. The wording in the README does not exactly cover your case, but a) if you prefer to not have commit access, you can just say so, and we will not add you and b) access restriction is primarily an anti-spam measure, and I think this exchange has already established that your objective is to improve the docs, rather than spamming.
Note that there in an in-flight PR #155 tidying some other issues caused by addition or Banner tutorial. I will edit that one to:
Updating the Quick Docs page is a good idea, the problem is the usual one: finding somebody who would bother.
That was my initial instinct, too. I saw the commit log mention why the GNU Hello program isn’t the best candidate for the stepping-stone tutorial. Then I saw the alias was moved to the renamed and realized it was a bug/oversight with the attribute usage. So, I opted to keep everything as-is instead of making a decision I have no right to make :).
Once I get confirmation, I’ll update and submit the PR accordingly.
Oh, I completely misinterpreted that. Thanks for the clarification.
EDIT
Oops, it looks like @oturpe replied the same time I did. Let me know if you want me to update this issue & submit a PR to fix this tiny edge case or if you want to keep everything in #155.
I added the fix into the existing pull requst. I am not completely sure how long it takes for the published page to get regenerated, but if you do not see it working in a couple of days, please let us know.
In case you find something else to fix or improve, please open another issue or pull request!
I can confirm that the changes in #155 are live. The link from the packaging guidelines is no longer broken, so this issue is resolved. Thanks for reporting it @codyrobertson.
Metadata Update from @carlwgeorge: - Issue status updated to: Closed (was: Open)
For posterity, I also updated the link in the Package Guidelines to use the direct link instead of relying on the alias.
https://pagure.io/packaging-committee/c/92d0338f36f2b47d3807e5890e8f6d6185fffbf0?branch=master
Log in to comment on this ticket.