fix: broken link on icons readme page in patternhub

[bruno-sch]

Proposed changes

Link is corrected. Fixes #2930

Types of changes

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Refactoring (fix on existing components or architectural decisions)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation Update (if none of the other choices apply)

Further comments

[github-actions]

🔭🐙🐈 Test this branch here: https://db-ui.github.io/mono/review/fix-link-in-patternhubs-icons-readme-broken

[mfranzke]

@nmerget even though that @bruno-sch has a valid solution here, it might not be the best, as I would assume that we should link to an .md file instead of the resulting path, shouldn't we ?

[nmerget]

If we want to enable the link in GitHub and Patternhub, we can't use relative paths. They have to be absolute :(

[mfranzke]

If we want to enable the link in GitHub and Patternhub, we can't use relative paths. They have to be absolute :(

por que? There seems to be some logic that let's those items appear as custom-icons path in the main navigation link. Why can't we use the same magic powder to even also rewrite any link to an .md file even for inline content?

[mfranzke]

this won't work if this documentation is opened via https://github.com/db-ui/mono/blob/fix-link-in-patternhubs-icons-readme-broken/packages/foundations/docs/Icons.md

[bruno-sch]

@mfranzke and @nmerget

That's basically true. In the end, this also applies to all other internal links here: If links point to paths with the file extension .md, they work in Github, but not in Patternhub. And vice versa.

A possible solution would be to have links in the md files end with the appendix .md. However, when copying these files to Patternhub via node-script, remove .md from links.

What do you think?

[mfranzke]

@mfranzke and @nmerget

That's basically true. In the end, this also applies to all other internal links here: If links point to paths with the file extension .md, they work in Github, but not in Patternhub. And vice versa.

A possible solution would be to have links in the md files end with the appendix .md. However, when copying these files to Patternhub via node-script, remove .md from links.

What do you think?

I agree with what you're suggesting. In either case we would need some kind of transformation of these links to another format. And as the codebase out of GitHub is displayed at github.com out of the box, but does get some kind of transformation for being displayed in "patternhub", we should rewrite the URL in the latter step / setup.

[mfranzke]

as aligned with @bruno-sch: the links within markdown need to be correct and during the transformation for GitHub Pages those links would need to get transformed as well to the resulting structure.

[mfranzke]

@nmerget could you please have a look how we could set the links within markdown to target other Markdown files and still have those links adapted within the transformation of patternhub ?