Update icon page link to ensure proper navigation #423
Conversation
Co-authored-by: Devon Rueckner <[email protected]>
Robustly handle missing icons.
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| <DocsPageTemplate apiDocs> | |||
| <DocsPageSection title="Overview" anchor="#overview"> | |||
| See <DocsInternalLink href="icons" text="the page on icons" /> for design guidance and a list of available icons. If an invalid icon is used, in development Vue.js validation will warn about the error. The icon will display as a broken image <KIcon icon="brokenImage" /> icon. | |||
| See <DocsInternalLink href="/icons" text="the page on icons" /> for design guidance and a list of available icons. If an invalid icon is used, in development Vue.js validation will warn about the error. The icon will display as a broken image <KIcon icon="brokenImage" /> icon. | |||
There was a problem hiding this comment.
There are (at least) a couple other places where this issue seems to exist:
Could possibly add some validation and/or fallback behavior to the DocsInternalLink component? Looks like most href attributes include a preceding / and this is the technically correct syntax.
There was a problem hiding this comment.
This change was lost. Added a PR here: #462
|
Will need to be rebased on top of the latest develop to get the new changelog. Also, please update it (the check doesn't work here yet, but perhaps it will start after the rebase) |
|
Is there a reason this is targeted to develop rather than release? Bad handling of missing icons is one of the most common errors we see emanating from KDS on Sentry. |
|
Sorry, scratch that - the extra commits here are the result of unmerged work from 1.4.x, attempting to resolve here: #456 |
No, it was just uninformed best guess based on the age of this PR.
Ah, thank you. Should we close this one then? |
|
Merged #456 |
Description
Currently clicking on the
iconspage link in the KIcon page takes you to a 404 - this does not happen when running locally though.Updates the href to be an absolute path to ensure it navigates to the correct place.