Skip to content

Conversation

@MylesJP
Copy link
Collaborator

@MylesJP MylesJP commented Nov 28, 2025

The ampersands in the 'MIR bug list' link caused it to break by not rendering properly in the address bar. Using a <a href> tag instead was advised as the preferred workaround to this common Sphinx problem.

Related issue


Checklist

  • I have read and followed the Ubuntu Project contributing guide
  • My pull request is linked to an existing issue (if applicable)
  • I have tested my changes, and they work as expected

The ampersands in the link caused it to not render properly
in the address bar. Using a <a href> tag was advised as the
preffered workaround to this common Sphinx problem.
Copy link
Collaborator

@cpaelzer cpaelzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That works for me, why exactly are we changing this?

Keep it in state "NEW" and do not assign it to anyone: this ensures that it
appears in the
[MIR bug list](https://bugs.launchpad.net/ubuntu/?field.searchtext=&orderby=-date_last_updated&field.status%3Alist=NEW&assignee_option=none&field.assignee=&field.subscriber=ubuntu-mir).
<a href="https://bugs.launchpad.net/ubuntu/?field.searchtext=&orderby=-date_last_updated&field.status%3Alist=NEW&assignee_option=none&field.assignee=&field.subscriber=ubuntu-mir">MIR bug list</a>.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I understand that you want to fix a problem, but it also breaks the nice "write MD and be happy" to a "included html" that we want to avoid where not strictly required.

I'd still say yes, but for me this just work.

  • hover tooltip - correct
  • clicking on the link - works

What exactly is it that fails when you say "not rendering properly in the address bar"?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually in #313 I find the details I need, reading there ...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arrr, I mean if ampersand in links would be rare - maybe, but it is THE way to pass arguments in an URL.
That can't be accepted as "it is broken" sigh, allow me a few more minutes to accept the sadness of this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I have to accept this all of these would need to become tags, urks :-/

$ grep -Hrn '(http.*\&'
grep: docs/MIR/.mir-roles-and-steps.md.swp: binary file matches
docs/MIR/mir-roles-and-steps.md:63:[MIR bug list](https://bugs.launchpad.net/ubuntu/?field.searchtext=&orderby=-date_last_updated&field.status%3Alist=NEW&assignee_option=none&field.assignee=&field.subscriber=ubuntu-mir).
docs/MIR/mir-team-meeting.md:50:* [New MIRs](https://bugs.launchpad.net/ubuntu/?field.searchtext=&orderby=-date_last_updated&field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&assignee_option=none&field.assignee=&field.subscriber=ubuntu-mir)
docs/MIR/mir-team-meeting.md:55:* [Incomplete bugs](https://bugs.launchpad.net/ubuntu/?field.searchtext=&orderby=-date_last_updated&field.status%3Alist=INCOMPLETE_WITH_RESPONSE&field.status%3Alist=INCOMPLETE_WITHOUT_RESPONSE&field.subscriber=ubuntu-mir)
docs/MIR/mir-team-meeting.md:67:* [Security assigned MIR in launchpad](https://bugs.launchpad.net/~ubuntu-security/+bugs?field.searchtext=%5BMIR%5D&assignee_option=choose&field.assignee=ubuntu-security&field.bug_reporter=&field.bug_commenter=&field.subscriber=ubuntu-mir&orderby=-date_last_updated&start=0)
docs/how-ubuntu-is-made/processes/new-packages.md:13:To get a package into Ubuntu, [file a bug in Launchpad](https://bugs.launchpad.net/ubuntu/+filebug?no-redirect&field.tag=needs-packaging) and make sure it has the tag [`needs-packaging`](https://lists.ubuntu.com/archives/ubuntu-motu/2007-March/001471.html).
docs/contributors/bug-triage/bug-tags.md:32:| [`fix-to-verify`](https://launchpad.net/ubuntu/+bugs?field.status:list=FIXRELEASED&field.tag=fix-to-verify) | A bug that is *{ref}`Fix Released <bug-status>`* and should be verified when performing ISO testing of daily builds or milestones |
docs/contributors/bug-triage/bug-tags.md:42:| [`needs-devrelease-testing`](https://launchpad.net/ubuntu/+bugs?orderby=-importance&field.status%3Alist=New&field.status%3Alist=Incomplete&field.status%3Alist=Invalid&field.status%3Alist=Won%27t+Fix&field.status%3Alist=Confirmed&field.status%3Alist=Triaged&field.status%3Alist=In+Progress&field.status%3Alist=Fix+Committed&field.status%3Alist=Fix+Released&field.tag=needs-devrelease-testing&search=Search) | A bug that existed in a previous release of Ubuntu and needs to be tested in the latest development release |
docs/contributors/bug-triage/bug-tags.md:131:| [`bitesize`](https://launchpad.net/ubuntu/+bugs?field.searchtext=linux&field.tag=bitesize) | For the kernel, this includes things like enabling modules and changing kernel config options |
docs/contributors/bug-triage/bug-tags.md:133:| [`hibernate-resume`](https://launchpad.net/ubuntu/+bugs?field.tags_combinator=ALL&field.tag=hibernate+resume) | This bug was triggered by a hibernate/resume failure |
docs/contributors/bug-triage/bug-tags.md:139:| [`suspend-resume`](https://launchpad.net/ubuntu/+bugs?field.tags_combinator=ALL&field.tag=suspend+resume) | This bug was triggered by a suspend/resume failure |
docs/contributors/bug-triage/index.md:55:Or you can [view all untriaged bugs](https://launchpad.net/ubuntu/+bugs?field.searchtext=&orderby=-datecreated&field.status%3Alist=Unconfirmed&field.importance%3Alist=Undecided&assignee_option=none&field.assignee=&field.owner=&field.component=1&field.component=2&field.component-empty-marker=1&field.omit_dupes.used=&field.omit_dupes=on&field.has_patch.used=&field.has_no_package.used=&search=Search).
docs/who-makes-ubuntu/developers/dmb-application.md:84:You can look at [past Wiki applications](https://wiki.ubuntu.com/Home?action=fullsearch&context=180&value=DeveloperApplication&titlesearch=Titles) such as [{spellexception}`Paride`'s](https://wiki.ubuntu.com/ParideLegovini/UbuntuServerDeveloperApplication) or check out the Discourse [Ubuntu Membership section](https://discourse.ubuntu.com/c/community/membership/93) if you need some examples.
docs/staging/dmb/ubuntu-development.md:116:[Showstopper bugs](https://bugs.launchpad.net/ubuntu/+bugs?field.searchtext=&orderby=-importance&search=Search&field.status%3Alist=Unconfirmed&field.status%3Alist=Needs+Info&field.status%3Alist=Confirmed&field.status%3Alist=In+Progress&field.status%3Alist=Fix+Committed&field.importance%3Alist=Critical&assignee_option=any&field.assignee=&field.bug_reporter=&field.bug_contact=&field.milestone%3Alist=50164&field.component=1&field.component=2&field.component-empty-marker=1&field.status_upstream=&field.status_upstream-empty-marker=1&field.omit_dupes.used=&field.omit_dupes=on&field.has_patch.used=&field.tag=&field.has_cve.used=&field.has_no_package.used=)
docs/staging/dmb/ubuntu-development.md:120:[Release-critical bugs](https://bugs.launchpad.net/ubuntu/+bugs?field.searchtext=&orderby=-importance&field.importance%3Alist=CRITICAL&field.importance%3Alist=HIGH&field.milestone%3Alist=50160&field.milestone%3Alist=50161&field.milestone%3Alist=50162&field.milestone%3Alist=50163&field.milestone%3Alist=50164) 
docs/staging/aa-museum.md:615:  [This query](https://bugs.launchpad.net/ubuntu/+bugs?field.subscriber=ubuntu-archive&field.status=NEW&field.status=Confirmed&field.status=Triaged&field.status=INPROGRESS&field.status=FIXCOMMITTED&field.status=INCOMPLETE_WITH_RESPONSE&orderby=-id&start=0)
docs/staging/release-team/seed-management.md:66:Some seeds have not yet been migrated to git. See [revision 73](https://wiki.ubuntu.com/SeedManagement?action=recall&rev=73) of this page for the old, bzr-based instructions.
docs/maintainers/AA/aa-package-removal.md:10:* [List of source package removal requests](https://bugs.launchpad.net/ubuntu/+bugs?field.subscriber=ubuntu-archive&field.status=NEW&field.status=Confirmed&field.status=Triaged&field.status=INPROGRESS&field.status=FIXCOMMITTED&field.status=INCOMPLETE_WITH_RESPONSE&orderby=-id&start=0)
docs/maintainers/niche-package-maintenance/rustc/backport-rust.md:198:You can monitor upload progress in the [Security Proposed PPA](https://launchpad.net/~ubuntu-security-proposed/+archive/ubuntu/ppa/+packages?field.name_filter=rustc&field.status_filter=&field.series_filter=).
docs/maintainers/niche-package-maintenance/rustc/update-rust.md:321:Finally, if you're not sure about how/if you should prune something, you can take a look at versions of the patch from earlier Rust updates to see if a different version of the vendored crate has been pruned before. [Here's](https://git.launchpad.net/~canonical-foundations/ubuntu/+source/rustc/tree/debian/patches/prune/d-0021-vendor-remove-windows-dependencies.patch?h=merge-1.85&id=80e81b6f85ef6086177991e34100e520bd142327) an example of a patch with a large list of vendored crates.
docs/maintainers/niche-package-maintenance/desktop/maintain-ubuntu-desktop-software.md:2:relatedlinks: "[PackagingWithGit &#32; - &#32; Debian Wiki](https://wiki.debian.org/PackagingWithGit), [Building &#32; Debian &#32; Packages &#32; with &#32; git-buildpackage](https://honk.sigxcpu.org/projects/git-buildpackage/manual-html/)"
docs/community/local/lc-create.md:28:   If not, you can request one by [filling out this form](https://docs.google.com/forms/d/e/1FAIpQLSf7auchvVzpkH_cQdUFiiRcyGHtrSrGG0GmeQXaKkDhXVpsmw/viewform?usp=sharing&ouid=101065845149003260161).
docs/community/contribute/patch-pilots.md:22:If you'd like to plan ahead, see the [Ubuntu Patch Pilots](https://calendar.google.com/calendar/embed?showPrint=0&showCalendars=0&mode=WEEK&src=Y184ZWRhZjk2OTllYWFmMWFmMmNjYTY2ZTYyOGZkNDEwODQ2ZTkwMjcwNmQ2YTMzMTU1OTNmODhiOTk0ZTZlOWE2QGdyb3VwLmNhbGVuZGFyLmdvb2dsZS5jb20&color=%23F4511E) calendar.
docs/community/contribute/patch-pilots.md:76:: There is a growing number of [open bugs with patches on them](https://bugs.launchpad.net/ubuntu/+bugs?field.subscriber=ubuntu-reviewers&field.tag=-patch-needswork%20-patch-forwarded-upstream%20-patch-forwarded-debian%20-patch-accepted-upstream%20-patch-accepted-debian%20-patch-rejected-upstream%20-patch-rejected-debian%20-patch-rejected&field.tags_combinator=ALL). Following the [Review Guide](https://wiki.ubuntu.com/ReviewersTeam/ReviewGuide#Workflow), you can help make sure community members have the support they need to get their patches into Ubuntu. Contributors might occasionally need clarification on the guidelines, and we're here to provide support and guidance.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additionally I just learned that the link checks are on markdown, converting HTML would break that for all of them. +1 on finding an actual fix instead of the workaround.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked a bit further, the interim doctrees are still fine so the myst parser seems not to break it. But then the intermediate (and the final) HTML is broken, but I got lost in the myriad of extensions and could not yet find which is causing this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've done some digging (and some testing) and it turns out this is a problem with docutils and sadly I don't think we're going to be able to solve it any other way than with the html links. It's not ideal, but there's no better solution that I can find :/

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s-makin can we in that case have a issue/PR about the link checker to please fail any link that has an & and is not using them? Once filed refer to it and close this comment please.

Copy link
Collaborator

@cpaelzer cpaelzer Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well @s-makin /SRU/reference/exception-Grub-Updates/ and SRU/reference/exception-UbuntuDevTools-Updates/ shows that RST format works btw :-/

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@s-makin I filed #332 for that, this can't stay as-is forever or needs a link checker to know about it.


### Refer back to reporter

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That whitespace change should be a different commit if you want to land it.
Or not present at all.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI @MylesJP I'm extending on yours fixing this in all places ...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While doing so referring to the fixed issue as well as fixing the whitespace damage

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI @MylesJP superseded by #331

@cpaelzer
Copy link
Collaborator

cpaelzer commented Dec 3, 2025

Your patch got in via #331 @MylesJP

@cpaelzer cpaelzer closed this Dec 3, 2025
@cpaelzer cpaelzer mentioned this pull request Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Broken MIR bug list URL

3 participants