Repository navigation
Add more guide versions #660
Description
Description
From keycloak/keycloak#33532 (comment)
"At the moment we're publishing "nightly" and "current" docs.
I would hope to publish for example the latest patch release of the previous minor release as well, by exchanging "nightly" with "26.3".
I would be +1 for that change given the value it would add for the community. If there would be a volunteer to implement it, I'd be happy to review it."
See also an approach to this using github pages with branches and submodules keycloak/keycloak#33532 (comment)
Discussion
No response
Motivation
To provide community users with the most relevant documentation to the version they are using.
Details
No response
Activity
stianst commentedon Oct 15, 2025
I don't really see it as a high priority to add docs/guides for what is unsupported releases; we also have an issue with how much space the docs takes and running out of GH pages space, which means we need to reduce this.
IMO we should consider adding guides for older versions, but not publish them, just make them downloadable as a ZIP; which I'm pretty sure we already have, we could just link to that.
That being said if there is wider consensus around making older versions available I'm okay with that (especially if it's limited to a specific number or something, and we have some auto-cleanup)
ahus1 commentedon Oct 15, 2025
I'd say that we should recognize that people would need to keep their servers running while they upgrade, so while KC 26.4 is out, we should also allow them to look at KC 26.3 docs.
At the moment, the only docs that we provide as downloads for the old HTML guides, but not the new guides when looking at the GitHub release. When looking at the Maven artifacts, you find the new guides here https://repo1.maven.org/maven2/org/keycloak/keycloak-guides/26.4.0/ - in ZIP file as AsciiDoc with some images.
So I'd say there is a need and a gap to what we currently provide. Possibly we could also provide a rendered version of the new guides as a downloadable archive.
stianst commentedon Oct 16, 2025
One thing that is a given let's make it consistent with guides + docs + javadocs + REST API docs.
In terms of versions (as a compromise) we could publish:
<latest>.<latest>.<latest>- latest release<latest>.<latest - 1>.<latest>- previous minor release<latest - 1>.<latest>.<latest>- previous major releaseIn addition we make archived versions of all the docs available as downloads through GH releases.
We would also need to automate the garbage collection of releases that should no longer be published. I really don't want to have to do that manually.
I do wish we had converted all docs to guides 6A99 though; so we don't have two different things to deal with.
ahus1 commentedon Oct 17, 2026
I used some of my spare time to fix this.