Skip to content

docs: fix markdown formatting for image name structure (#757) - #762

Merged
Vad1mo merged 2 commits into
goharbor:mainfrom
Mannan-Ali:fix-issue-757-image-tag
Sep 21, 2026
Merged

Vad1mo merged 2 commits into
goharbor:mainfrom
Mannan-Ali:fix-issue-757-image-tag

Conversation

@Mannan-Ali

Copy link
Copy Markdown
Contributor

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 main so it can be applied to the edge docs. Please backport this fix to release-2.15.0 (and any other applicable release branches).

Screenshots / Verification:

Here is how it looks now on the local edge build:
image

Signed-off-by: Mannan-Ali <alimannan.am244@gmail.com>
@Mannan-Ali
Mannan-Ali requested review from a team as code owners August 26, 2026 05:28
@Vad1mo
Vad1mo enabled auto-merge (squash) August 26, 2026 05:30
Comment thread docs/working-with-projects/working-with-images/pulling-pushing-images.md Outdated
Comment thread docs/working-with-projects/working-with-images/pulling-pushing-images.md Outdated
auto-merge was automatically disabled September 20, 2026 04:46

Head branch was pushed to by a user without write access

Signed-off-by: Mannan-Ali <alimannan.am244@gmail.com>
@Mannan-Ali
Mannan-Ali force-pushed the fix-issue-757-image-tag branch from f6032d6 to 524a0bf Compare September 20, 2026 04:49
@Mannan-Ali

Copy link
Copy Markdown
Contributor Author

Hi @kastl-ars , thanks for the review! I've made those changes:

  • Added a period at the end of the sentence about the <project_name>/<repository_name> format.
  • Wrapped demo, ubuntu, and 14.04 in backticks in the image name structure examples.

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
Vad1mo enabled auto-merge (squash) September 20, 2026 11:55

@Vad1mo Vad1mo left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

@wy65701436 wy65701436 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@Vad1mo
Vad1mo merged commit dda1240 into goharbor:main Sep 21, 2026
5 checks passed
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.

[documentation] "Pushing images": Missing tag due to markdown issues?

6 participants