fixup: some broken docs links #474
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
guicassolato
reviewed
Jul 6, 2024
jasonmadigan
force-pushed
the
markdown-links
branch
28 times, most recently
from
4dda11d to
4ac37fd
Compare
jasonmadigan
force-pushed
the
markdown-links
branch
16 times, most recently
from
9d414c8 to
54047e0
Compare
jasonmadigan
force-pushed
the
markdown-links
branch
from
54047e0 to
582813c
Compare
| </summary> | ||
| <summary>Authorino capabilities featured in this guide</summary> | ||
|
|
||
| - Common feature → [Caching](../features.md#common-feature-caching-cache) |
There was a problem hiding this comment.
I came across this today and hit a 404 on the docs site at https://docs.kuadrant.io/0.11.0/authorino/docs/user-guides/caching/
@guicassolato I think this should be merged asap as there's lots of broken/404 links
jasonmadigan
force-pushed
the
markdown-links
branch
from
582813c to
d1cfde5
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!