Skip to content

Conversation

@gracegrimwood
Copy link
Member

@gracegrimwood gracegrimwood commented Jan 5, 2026

This PR is the website portion of the work to fix kroxylicious/kroxylicious#238 (Javadoc redirect links broken). This sets up the scaffolding on the website side for getting the Javadoc published — there will be a second PR (edit: this one) on the Kroxylicious repo side to aggregate that Javadoc and push it into this repo during releases alongside the current Asciidoc push.

Things not included in this PR that could or possibly should be: (I ran out of time to finish them, because I spent far too long arguing with CSS conflicts)

  • Haven't got a good way of dealing with multiple versions of Javadoc. Not a problem if we only care about the latest, might become a problem if we want to have a historical record on the site.
  • The current mechanism used to get the Javadoc to render nicely and also get the Kroxylicious website header over top of it is an iframe, which is a bit of a risky move because it's been talked about being deprecated for decades. Alas, the other option was rewriting either the Javadoc styles or the website styles from scratch, and so using iframes seemed like the easier option.
  • The way the files get put into this repo so that they play nice with Jekyll is kind of gross (the script for this will be in the other PR). It copies all the files over, and then for every HTML file it generates a second blank HTML file for us to put the iframe into and use to render the canonical links. It's kinda grotty, but it works.

NB: I've left IBM now, but I still have a laptop and slack and email, so just let me know if I need to put a bit more work into this. I just may not be as quick to respond as I used to be.

Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
Signed-off-by: Grace Grimwood <ggrimwoo@redhat.com>
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.

Javadoc links broken

1 participant