Repository navigation
docs: fix markdown formatting for image name structure (#757) - #762
Conversation
Signed-off-by: Mannan-Ali <alimannan.am244@gmail.com>
Head branch was pushed to by a user without write access
Signed-off-by: Mannan-Ali <alimannan.am244@gmail.com>
f6032d6 to
524a0bf
Compare
|
Hi @kastl-ars , thanks for the review! I've made those changes:
Could you please approve the workflows so the CI checks can run? If there's anything else that needs to be updated before this can move forward, let me know and I'll take care of it right away. Thanks! |
Vad1mo
left a comment
There was a problem hiding this comment.
Re-approving for 524a0bf; my earlier approval was on 78553bd.
Root cause confirmed: the site sets unsafe = true for Goldmark, so <tag> is emitted as raw HTML and swallowed by the browser. The backticks fix that.
One follow-up, not blocking: the demo: / ubuntu: / 14.04: lines are soft line breaks inside a single paragraph, so they still render as one run-on sentence. Prefixing those three lines with - would make them a proper list.
This also needs a backport to release-2.15.0, which is the version users land on.
What this PR does / why we need it:
This PR fixes an issue where the
<tag>portion of the image name structure was missing from the rendered documentation. Because it lacked Markdown backticks, the browser was treating<tag>as a hidden HTML element.By enclosing
<project_name>/<repository_name>:<tag>in backticks, it is now properly rendered as an inline code block.I also added backticks to the other image name examples in the immediately surrounding lines to ensure the formatting remains consistent across the entire section.
Fixes #757
Note for Maintainers:
This formatting issue affects the current release versions (e.g., 2.15.0) as well. As per the contributing guidelines, I am submitting this against
mainso it can be applied to the edge docs. Please backport this fix torelease-2.15.0(and any other applicable release branches).Screenshots / Verification:
Here is how it looks now on the local edge build:
