8000 Fix link broken in downstream by andymunro · Pull Request #53563 · keycloak/keycloak · GitHub
[go: up one dir, main page]

Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/guides/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
:adminguide_link: {project_doc_base_url}/server_admin/
:adminguide_vault: {adminguide_link}#_vault-key-resolvers
:adminguide_user_locale: {adminguide_link}#_user_locale_selection
:adminguide_x509: {adminguide_link}#_x509
@mabartos mabartos Oct 12, 2026 •
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think the X.509 section should have the separate attribute record as it's not any special. We should have the same problem with the _vault-key-resolvers, and _client_policies IDs, as they also use the underscore as a prefix.

So for now, I'd suggest using the auxiliary anchor (if feasible) to support both and be able to backport it:

[[x509]]
=== [[_x509]]X.509 client certificate user authentication

For the main, it'd be good to restrict using the anchors with an underscore prefix -> so, we'd need to find all references in guides + add some compile checks for the docs. Should be handled in a follow-up issue.

@andymunro WDYT? Could you please also fix the other references?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have not used Auxillary anchors before, but I can see how it works. @ahus1 do you agree with this idea? In the next release, downstream will be in a completely separate repository. So I would not invest a lot of time with this issue.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considering we're using the :adminguide_vault: {adminguide_link}#_vault-key-resolvers already in the attributes, I'm ok to go with this change (and maybe also add the attribute for the _client_policies).

And for the Keycloak 27, we can provide some better approach.

@andymunro WDYT? So, can you resolve the conflict?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I will defer to @ahus1 who has a lot more insight in what works best with this change.

:quickstartRepo_link: https://github.com/keycloak/keycloak-quickstarts
:quickstartRepo_name: Keycloak Quickstarts Repository
:quickstartRepo_dir: keycloak-quickstarts
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/server/mutual-tls.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,6 @@ the HttpClient to provide the right certificates in the keystore for the outgoin

=== Configuring X.509 Authentication

For more information on how to configure X.509 Authentication, see link:{adminguide_link}#_x509[X.509 Client Certificate User Authentication section].
For more information on how to configure X.509 Authentication, see link:{adminguide_x509}[X.509 Client Certificate User Authentication section].

</@tmpl.guide>
Loading
0