8000 Use version drop-downs for docs and downloads · Issue #665 · keycloak/keycloak-web · GitHub
[go: up one dir, main page]

Skip to content

Use version drop-downs for docs and downloads #665

Open

Description

@shawkins

Description

Docs and downloads use archive pages, such as https://www.keycloak.org/documentation-archive.html these can be done as drop-downs as well to be consistent with #659

Discussion

No response

Motivation

Improve consistency on our pages and allow users to easily navigate between versions.

Details

No response

Activity

  1. stianst commented on Oct 15, 2025

    @stianst
    Contributor

    I disagree with this; the documentation for the older and no longer supported releases are archived; as such shouldn't be readily available and published with a drop-down.

  2. vmuzikar commented on B5BC Oct 15, 2025

    @vmuzikar
    Contributor

    @stianst The motivation was to align what we're doing for guides in #659.

  3. stianst commented on Oct 15, 2025

    @stianst
    Contributor

    #659 makes little sense to me; we have a single version of the new guides. Nightlies was also supposed to be a bit more hidden, and only visible through the nightly page.

    We also have an issue with the docs + api-docs being rather large and we're close to running out of space on GH pages; that means that historically we've purged older versions; but what I'm rather thinking about is we'll only make the archived docs available as ZIPs (downloads through GH releases), and not publish old versions at all.

  4. shawkins commented on Oct 15, 2025

    @shawkins
    ContributorAuthor

    @stianst the original pr for #659 was to just add the version to the pages so that it was clear to users what version of the guide they were looking at. In particular this has come up multiple times for the config pages for the server and providers ( https://www.keycloak.org/server/all-config). Having an explicit version also makes it easier to look back in web archives to find the docs relevant to your non-current release.

    This was changed to a drop-down based upon a suggestion by @ahus1. It would probably be best to follow-up on that issue / pr if you don't like that approach.

    We also have an issue with the docs + api-docs being rather large and we're close to running out of space on GH pages; that means that historically we've purged older versions; but what I'm rather thinking about is we'll only make the archived docs available as ZIPs (downloads through GH releases), and not publish old versions at all.

    I'm not sure that matters to this issue. Whether we're talking about zip links or links to the actual docs, that can be presented via a drop-down rather than directing the user to a page like https://www.keycloak.org/documentation-archive.html

    Can you add your concerns / direction about multiple guide / doc versions to #660?

  5. vmuzikar commented on Oct 15, 2025

    @vmuzikar
    Contributor

    @stianst Are you ok with #659? I don't feel strongly about the latest/nightly select but I do agree we should at least state the version to which the guides apply.

  6. stianst commented on Oct 15, 2025

    @stianst
    Contributor

    It's a bit weird, but don't care all that much

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      0