-
Notifications
You must be signed in to change notification settings - Fork 428
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
base: main
Are you sure you want to change the base?
Conversation
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 |
@jonkoops We are doing exactly the same it's done for This PR is to do the pre-processing that is done in We can just add the adoc here in the specific format the |
Got it, thanks for the explainer! |
Closes #35539 Signed-off-by: rmartinc <[email protected]>
24ea28a
to
5d0d023
Compare
There was a problem hiding this 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 .
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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 |
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 usingnpm run guides
that downloads and executes thefmpp
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 thekeycloak-web
.@jonkoops When you have time, take a look (next year 😄).