vmware / vmware/photon

Link not being parsed correctly in documentation

Open
#1,406 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C
Stars
3.2k
Forks
692
PR merge metrics
No merged PRs in 30d

Description

Describe the bug

The first download link on the Prerequisites for running Photon OS on vSphere page is not getting parsed as a link an is displaying the markdown directly.

Reproduction steps
  1. Visit the aforementioned page
Expected behavior

A link appears like https://packages.vmware.com/photon/ in the last cell of the table.

Additional context

This is because markdown syntax is not parsed inside of block-level elements.

e.g.

<div>[https://example.com](https://example.com)</div>
[https://example.com](https://example.com)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the source for the Prerequisites for running Photon OS on vSphere page and reproduce the first download link rendering issue. Adjust the page markup so the packages.vmware.com/photon link renders as a link in the table, then verify the published page displays it correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.