External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Remove upgrading client libraries from the server documentation (#35101)

Browse Source 
closes #34949

Signed-off-by: mposolda <mposolda@gmail.com>


Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
Signed-off-by: Marek Posolda <mposolda@gmail.com>
This commit is contained in:
Marek Posolda 2024-11-20 16:14:42 +01:00 committed by GitHub
parent ae7765e17b
commit a56378e989
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 6 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/documentation/release_notes/topics/26_0_0.adoc
View File

@ -23,7 +23,7 @@ The client libraries are supported with Java 8, so it is possible to use them wi
Beginning with this release, we are testing and supporting client libraries with the same server version and a few previous major server versions.
For details about supported versions of client libraries with server versions, see the link:{upgradingguide_link}#_upgrade_client_libraries[{upgradingguide_name}].
For details about supported versions of client libraries with server versions, see the link:{upgradingclientlibs_link}[{upgradingclientlibs_name}].
= User sessions persisted by default

2
docs/documentation/topics/templates/document-attributes.adoc
View File

@ -77,6 +77,8 @@
:upgradingguide_name_short: Upgrading
:upgradingguide_link: {project_doc_base_url}/upgrading/
:upgradingguide_link_latest: {project_doc_base_url_latest}/upgrading/
:upgradingclientlibs_link: https://www.keycloak.org/securing-apps/upgrading
:upgradingclientlibs_name: Upgrading {project_name} Client libraries
:releasenotes_name: Release Notes
:releasenotes_name_short: {releasenotes_name}
:releasenotes_link: {project_doc_base_url}/release_notes/

5
docs/documentation/upgrading/topics/intro.adoc
View File

@ -7,5 +7,6 @@ This guide describes how to upgrade {project_name}. Use the following procedures
. Review the migration changes from the previous version of {project_name}.
. Upgrade the {project_name} server.
. Upgrade the {project_name} adapters.
. Upgrade the {project_name} Admin Client.
. Upgrade the {project_name} Client Libraries (Admin client, Authorization client, Policy enforcer). These are released independently of the {project_name} server
and could be typically updated independently of the {project_name} server as the last released version of the client libraries should be compatible with the last released version of
the {project_name} server. For more information, see the link:{upgradingclientlibs_link}[{upgradingclientlibs_name}].

21
docs/documentation/upgrading/topics/upgrade_client_libs.adoc
View File

@ -1,21 +0,0 @@
= Upgrading the {project_name} Client Libraries
[[_upgrade_client_libraries]]
The client libraries are those artifacts:
* Java admin client - Maven artifact `org.keycloak:keycloak-admin-client`
* Java authorization client - Maven artifact `org.keycloak:keycloak-authz-client`
* Java policy enforcer - Maven artifact `org.keycloak:keycloak-policy-enforcer`
ifeval::[{project_community}==true]
The client libraries are supported with the last supported {project_name} server version.
endif::[]
ifeval::[{project_product}==true]
The client libraries are supported with all the supported {project_name} server versions. The fact that client libraries are supported with more server versions makes the update easier,
so you may not need to update the server at the same time when you update client libraries of your application.
endif::[]
It is possible that client libraries may work even with the older releases of the {project_name} server, but it is not guaranteed and officially supported.
It may be needed to consult the javadoc of the client libraries like Java admin-client to see what endpoints and parameters are supported with which {project_name} server version.

2
docs/documentation/upgrading/topics/upgrading.adoc
View File

@ -13,5 +13,3 @@ include::migrate_db.adoc[leveloffset=1]
include::migrate_themes.adoc[leveloffset=1]
include::upgrade_adapters.adoc[leveloffset=1]
include::upgrade_client_libs.adoc[leveloffset=1]