Skip to content

Introduce versioned documentation #2905

Description

@michaelkoepf

Is your feature request related to a problem? Please describe.
Documentation (i.e., pages that contain version-specific Operator SDK links and information) should be versioned.

Describe the solution you'd like
Use doc versioning feature of docsy.

Steps:

  • Find out how to use doc versioning feature (see link above)
  • For each release (maybe only up to v4?), check out the state of the website back then and build it [*].
  • Replace all absolute links to javaoperatorsdk.io with relative links of the current website version.
  • Deploy all past and the current version.
  • Adapt CI/CD pipelines.

[*] But take care of absolute links to javaoperatorsdk.io. These need to be replaced first.

The ultimate goal should be to have versioned docs incl. the "latest" version (next release).

Describe alternatives you've considered
n/a

Additional context
n/a

Activity

  1. csviri commented on Aug 21, 2025

    @csviri
    Collaborator

    @michaelkoepf thx, yes this would be nice to have; do you plan to do a PR for this? it would great thx

  2. michaelkoepf commented on Aug 22, 2025

    @michaelkoepf
    ContributorAuthor

    @csviri in general yes, but this will not happen any time soon i think :( maybe we can label it as good first issue and if somebody stumbles upon it and wants to pick it up, they can go ahead.

  3. added
    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.
    on Aug 22, 2025
  4. added 2 commits that reference this issue on Apr 22, 2026
    4ec951c
    5fdd0f3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions