search

keycloak / keycloak

Open Source Identity and Access Management For Modern Applications and Services
https://www.keycloak.org
Apache License 2.0
22.64k stars 6.65k forks source link

Documentation: Align on one placeholder syntax #33018

Open janv8000 opened 2 weeks ago

janv8000 commented 2 weeks ago

Description

See #32912 for realm-name.

Nice-to-have would be to placeholderize more:

Placeholder already present but not for all the parts

/auth/realms/realm_here/protocol/saml/clients/{client_name} => /auth/realms/{realm-name}/protocol/saml/clients/{client_name}

/auth/realms/{realm-name}/protocol/saml/clients/client_here => /auth/realms/{realm-name}/protocol/saml/clients/{client_name}

No placeholders present

/auth/realms/realm_here/protocol/saml/clients/client_here => /auth/realms/{realm-name}/protocol/saml/clients/{client_name}

marvelshan commented 1 day ago

Hi @janv8000 - can I pick this up? Deeply passionate about Keycloak and would love to start my contribution to Keycloak with this issue. However, I am a beginner, so if there are things I don't understand, I hope I can ask for your guidance.

janv8000 commented 1 day ago

Fine by me, however I'm not really involved in this project nor am I a Java afficionado :) On the domains I can assist on, sure

marvelshan commented 1 day ago

Ok! I have currently found the location in the following directory: js/apps/admin-ui/maven-resources/theme/keycloak.v2/admin/messages. In the data, there is {server-root}/realms/{realm}/protocol/saml/clients/{client-url-name}. Is this the part that needs to be modified as mentioned earlier?

js/apps/admin-ui/maven-resources-community/theme/keycloak.v2/admin/messages/messages_ca.properties js/apps/admin-ui/maven-resources-community/theme/keycloak.v2/admin/messages/messages_es.properties ...and so on.

janv8000 commented 1 day ago

What you are refering to looks to me as being part of a l10n-facility in the Keycloak application itself as opposed to the documentation. Feedback on application/code changes should come from the project-members, my intent on this issue was to go through the documentation in https://github.com/keycloak/keycloak/tree/main/docs/documentation ....

marvelshan commented 19 hours ago

I am currently working on the file server_admin/topics/admin-cli.adoc, and at line 1514, I noticed that the following part hasn't been placeholderized. Should I make the following change?

-http://localhost:8180{kc_realms_path}/saml-broker-realm/protocol/saml
+http://localhost:8180{kc_realms_path}/{saml-broker-realm}/protocol/saml