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 for Node.js adapter into own repo #545

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rmartinc
Copy link

Closes #35539

Just a draft for the moment. As commented in the issue there is a new script guides/guides.js that can be executed using npm run guides that downloads and executes the fmpp tool to create the freemaker guides. The final output is a zip with teh guides like in any of our other projects: guides/target/keycloak-nodejs-connect-guides-<version>.zip. This zip should be uploaded to somewhere to later be used by the keycloak-web.

@jonkoops When you have time, take a look (next year 😄).

@jonkoops
Copy link
Contributor

Is there a particular reason we would want to build the documentation here using Node.js? If I am not mistaken we build the documentation for the keycloak-client repo from keycloak-web, should we not do the same here?

@rmartinc
Copy link
Author

@jonkoops We are doing exactly the same it's done for keycloak-client. The keycloak-web expects the guides in a specific format that in keycloak-client is generated using a plugin here. And the plugin is in another sub-project. After that keycloak-web performs a second processing getting the guides and generating the web in html.

This PR is to do the pre-processing that is done in keycloak-client but for the nodejs repo. After that the zip generated here should be consumed by keycloak-web in the same way that is done for the clients.

We can just add the adoc here in the specific format the keycloak-web wants it, but there should be some minimal processing (at least adding the version, some other minor things and finally generating the zip with it). But I prefer to do the same than in the other projects (with the templates and everything) just in case the format for the guides change in the future. This way we are doing the same in all repos.

@jonkoops
Copy link
Contributor

Got it, thanks for the explainer!

guides/guides.js Outdated Show resolved Hide resolved
guides/guides.js Outdated Show resolved Hide resolved
guides/guides.js Outdated Show resolved Hide resolved
guides/guides.js Outdated Show resolved Hide resolved
guides/guides.js Outdated Show resolved Hide resolved
guides/images/keycloak_logo.png Outdated Show resolved Hide resolved
Copy link
Contributor

@mposolda mposolda left a comment

Choose a reason for hiding this comment

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

Approving as the idea of this PR looks good to me.

I am leaving more thorough review (related to node.js tooling etc) to @jonkoops .

Copy link
Contributor

@jonkoops jonkoops left a comment

Choose a reason for hiding this comment

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

LGTM

@rmartinc
Copy link
Author

Moving out from draft now. after this we have to think where we want to upload the zip (maven or any other place?) to be used by the keycloak-web.

@rmartinc rmartinc marked this pull request as ready for review December 19, 2024 13:10
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.

3 participants