Update admin console documentation links
See original GitHub issueDescribe the bug
This is a follow-up to add new doc links for the Learn more links that appear on all landing pages of the new admin console, which were added in https://github.com/keycloak/keycloak-admin-ui/pull/1747.
How to update links
This is the file that contains all of the help URLs that need to be updated to the latest docs:
src/help-urls.ts
Currently, the file contains links to the closest match in the existing docs on keycloak.org. The admin guide main URL is listed at the top of the page:
const adminGuide = "https://www.keycloak.org/docs/latest/server_admin/index.html";
And each of the URLs is a specific anchor within that main URL, e.g.:
clientsUrl: ${adminGuide}#assembly-managing-clients_server_administration_guide,
So you would just need to edit the one adminGuide URL at the top of the page with the latest admin guide’s index.html, and each of the 11 landing page URLs with the latest anchors.
Also, there are 5 landing pages that are missing descriptions at the top of the page. For these, you could just edit the “Placeholder for…” strings in these files:
src/authentication/messages.ts
authenticationExplain: "Placeholder for authentication explanation.",
src/groups/messages.ts
groupsDescription: "Placeholder for authentication explanation.",
src/realm-settings/messages.ts
realmSettingsExplain: "Placeholder for realm settings explanation.",
src/sessions/messages.ts
sessionExplain: "Placeholder for sessions explanation.",
src/user/messages.ts
usersExplain: "Placeholder for users explanation.",
Issue Analytics
- State:
- Created 2 years ago
- Comments:8 (6 by maintainers)
Top GitHub Comments
Okay, thanks, @agagancarczyk and @ssilvert. However, I should have made databases plural in the last one.
@agagancarczyk Thanks for checking this out.
We could get Andy to come up with text for those missing subscriptions. But it might be quicker if you just come up something yourself and then ask Andy to review. Probably, there is some text you can use in the documentation.