Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation to keycloak-client #28

Merged
merged 1 commit into from
Sep 4, 2024

Conversation

rmartinc
Copy link
Contributor

@rmartinc rmartinc commented Aug 16, 2024

Moving the documentation to the keycloak-client. The idea is the commented chapters are moved to the new keycloak-client project as guides. The plugin used in keycloak is copied but removed the specific keycloak parts (it's simpler). I don't think this will be changed a lot.

In order to complete the issue we need two more PRs in different projects:

The new guides are generated in the keycloak-web as a new section:

Screenshot from 2024-08-16 11-13-40

And each section is just a normal guide (for example the first one):

Screenshot from 2024-08-16 11-15-07

Draft for the moment.

@mposolda
Copy link
Contributor

mposolda commented Aug 16, 2024

@rmartinc Thanks!

I have one small concern related to policy-enforcer javascript adapter. The JS adapter is still part of the main Keycloak repository and hence makes sense if it is still documented there. So can be better to either keep that one (file enforcer-js-adapter.adoc) in the keycloak and either keep in authorization-services docs or move to the JS adapter docs (which was already converted to guides). WDYT?

Copying the maven plugin from Keycloak is not so great, but IMO it is OK. Especially considering that it is relatively simple thing, which does not change too often and I don't see much better solutions for it, which are simple at the same time (anything more fancy can make things unnecessary complicated, so not sure if it worth it...)

@rmartinc
Copy link
Contributor Author

I have one small concern related to policy-enforcer javascript adapter. The JS adapter is still part of the main Keycloak repository and hence makes sense if it is still documented there. So can be better to either keep that one (file enforcer-js-adapter.adoc) in the keycloak and either keep in authorization-services docs or move to the JS adapter docs (which was already converted to guides). WDYT?

Yes, no problem, I simply moved the whole chapter. 😄 I will move back to the documentation. Then I ned to change two of the three PRs.

@rmartinc
Copy link
Contributor Author

@mposolda The policy-enforcer javascript adapter chapter has been maintained in the authorization services documentation and removed from the client.

@rmartinc rmartinc force-pushed the issue-31870 branch 2 times, most recently from 14e07dd to 8bc0093 Compare August 20, 2024 08:28
@rmartinc
Copy link
Contributor Author

Thanks @stianst! All done! I have picked all the commits and done the manual changes. The final version attribute for the client is client_version instead of client-version because the hyphen seems to be problematic. Thanks!

Closes #31870

Signed-off-by: rmartinc <[email protected]>
@rmartinc
Copy link
Contributor Author

Rebased! It was needed.

@mposolda mposolda marked this pull request as ready for review September 4, 2024 06:54
@mposolda
Copy link
Contributor

mposolda commented Sep 4, 2024

@rmartinc @stianst @pskopek Thanks for the PR and reviews

@mposolda mposolda merged commit 3ef279a into keycloak:main Sep 4, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants