Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixup: some broken docs links #474

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fixup: some broken docs links #474

wants to merge 1 commit into from

Conversation

jasonmadigan
Copy link
Member

@jasonmadigan jasonmadigan commented Jul 5, 2024

We've a decent amount of 404'ing content across our docs content.

https://github.com/Kuadrant/docs.kuadrant.io/actions/runs/9807810746/job/27082317585

Some noticed in Authorino's docs have a similar pattern which should be simple/regexable to fix.

Example Broken links: https://docs.kuadrant.io/0.8.0/authorino/docs/user-guides/resource-level-authorization-uma/

External auth metadata → User-Managed Access (UMA) resource registry =>
https://docs.kuadrant.io/0.8.0/authorino/docs/user-guides/features.md#user-managed-access-uma-resource-registry-metadatauma

Should be:

https://docs.kuadrant.io/0.8.0/authorino/docs/features#user-managed-access-uma-resource-registry-metadatauma

With markdown links, the relative link above are resolved and pre-processed before render. HTML is generally passed straight through, untouched, so these relative links end up broken unfortunately.

This is probably a bit of a PITA to review: sorry!

@jasonmadigan jasonmadigan marked this pull request as draft July 8, 2024 07:28
@jasonmadigan jasonmadigan force-pushed the markdown-links branch 28 times, most recently from 4dda11d to 4ac37fd Compare July 9, 2024 10:39
@jasonmadigan jasonmadigan force-pushed the markdown-links branch 16 times, most recently from 9d414c8 to 54047e0 Compare July 9, 2024 11:49
@jasonmadigan jasonmadigan marked this pull request as ready for review July 9, 2024 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

2 participants