Skip to content

fix: EOL documentation#13830

Open
ossdhaval wants to merge 2 commits intomainfrom
fix-eol-jans
Open

fix: EOL documentation#13830
ossdhaval wants to merge 2 commits intomainfrom
fix-eol-jans

Conversation

@ossdhaval
Copy link
Copy Markdown
Contributor

@ossdhaval ossdhaval commented Apr 16, 2026

Closes #13568

Summary by CodeRabbit

  • Documentation
    • Updated software lifecycle documentation to clarify version support phases and transitions between maintenance stages.
    • Refined definitions for End of Maintenance and End of Life milestones to better explain support transitions.
    • Updated version support timeline dates for improved accuracy.

Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval requested a review from moabu April 16, 2026 12:36
@ossdhaval ossdhaval self-assigned this Apr 16, 2026
@mo-auto
Copy link
Copy Markdown
Member

mo-auto commented Apr 16, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 16, 2026

📝 Walkthrough

Walkthrough

Updated docs/EOL.md to explicitly scope lifecycle information to version 2.0.0 and later, refined EOM and EOL milestone definitions to clarify support transitions, renamed the version status section, adjusted lifecycle dates by updating v1.x.0 end-of-life date and removing v2.x.x status rows, and removed redundant formatting separators.

Changes

Cohort / File(s) Summary
Documentation - End of Life
docs/EOL.md
Updated lifecycle wording and scope to version 2.0.0+, refined EOM/EOL milestone descriptions, renamed "Active Version Status" section to "Version Status", adjusted version table dates (v1.x.0 EOL from 2026-03-14 to 2026-11-14 Projected), removed v2.x.x status rows, and cleaned up formatting separators.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • ci: add EOL documentation #13387: Both PRs modify docs/EOL.md with the first introducing the EOL document and this PR updating its wording, dates, and section organization.

Suggested reviewers

  • moabu
  • manojs1978
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description is minimal but the linked issue provides sufficient context. However, the PR lacks details matching the template structure with Implementation Details and Test/Documentation sections. Expand the PR description to include Implementation Details section explaining the changes made and confirm that all checklist items from the template are addressed.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: EOL documentation' accurately describes the main change of updating EOL documentation with corrected dates and refined descriptions.
Linked Issues check ✅ Passed The PR successfully addresses issue #13568 by updating EOL dates in documentation (v1.x.0 support date changed from 2026-03-14 to 2026-11-14) and refining EOL/EOM milestone descriptions as required.
Out of Scope Changes check ✅ Passed All changes are scoped to updating EOL documentation to align dates and clarify support phases. Minor formatting changes (section rename, removed horizontal rules) are directly related to improving the documentation clarity.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-eol-jans

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@mo-auto mo-auto added area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality labels Apr 16, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/EOL.md`:
- Line 12: Add a short “Legacy policy/exception” note in docs/EOL.md clarifying
why the v1.x.0 row does not follow the T0+12/T0+24 GA-based formula: state that
the main lifecycle formula applies only to versions >= 2.0.0, and that v1.x.0
dates (e.g., projected EOL 2026-11-14) are calculated under a legacy
schedule/contractual timeline or manual projection based on GA 2024-03-14 and
any exceptions; add this as a footnote or a parenthetical sentence next to the
v1.x.0 table row and mirror the same clarification where the T0+12/T0+24 formula
appears (lines referenced in the comment: the GA formula and the v1.x.0 row) so
the table and policy are no longer contradictory.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 349a7f59-983d-4fd9-bb0b-a65a68eb3471

📥 Commits

Reviewing files that changed from the base of the PR and between 3fb2ad2 and 05d85f2.

📒 Files selected for processing (1)
  • docs/EOL.md

Comment thread docs/EOL.md
## 1. Lifecycle Overview

Our End of Life (EOL) policy is designed to provide a predictable schedule for support and upgrades. The lifecycle of any major version is calculated based on its original **General Availability (GA)** date.
Our End of Life (EOL) policy is designed to provide a predictable schedule for support and upgrades. The lifecycle of any major version is calculated based on its original **General Availability (GA)** date. This applies to version 2.0.0 and later releases.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

Clarify why v1.x.0 does not follow the stated lifecycle formula.

The document now states lifecycle math (T0+12 / T0+24) and also scopes policy to 2.0.0+, but the v1.x.0 row uses a projected EOL (2026-11-14) that does not derive from the shown formula using GA 2024-03-14. Please add an explicit “legacy policy/exception” note (or footnote in the table) explaining how v1.x.0 dates are calculated, so the table and policy are not interpreted as contradictory.

Also applies to: 19-20, 28-28

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/EOL.md` at line 12, Add a short “Legacy policy/exception” note in
docs/EOL.md clarifying why the v1.x.0 row does not follow the T0+12/T0+24
GA-based formula: state that the main lifecycle formula applies only to versions
>= 2.0.0, and that v1.x.0 dates (e.g., projected EOL 2026-11-14) are calculated
under a legacy schedule/contractual timeline or manual projection based on GA
2024-03-14 and any exceptions; add this as a footnote or a parenthetical
sentence next to the v1.x.0 table row and mirror the same clarification where
the T0+12/T0+24 formula appears (lines referenced in the comment: the GA formula
and the v1.x.0 row) so the table and policy are no longer contradictory.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not required.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ossdhaval, understood — no changes needed here. Thanks for the clarification!


🧠 Learnings used
Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 13748
File: docs/cedarling/reference/cedarling-policy-store.md:88-94
Timestamp: 2026-04-14T12:20:54.423Z
Learning: In `docs/cedarling/reference/cedarling-policy-store.md` (and related Cedarling directory-based policy store docs), the `id("...")` annotation is documented as a hard requirement for policies even though the parser still accepts single-policy files without it (falling back to filename-derived IDs for backward compatibility). This is intentional: the docs describe only the new/recommended API, not the backward-compatible fallback. Do not flag the missing mention of the filename-fallback as an inconsistency.

Learnt from: moabu
Repo: JanssenProject/jans PR: 13060
File: CHANGELOG.md:25-26
Timestamp: 2026-01-22T14:33:53.554Z
Learning: Repo: JanssenProject/jans — For Release Please-generated PRs (chore(main): release …), CHANGELOG.md is auto-generated; avoid suggesting manual edits (e.g., duplicate/formatting cleanups) and ignore minor nits in that file.

Learnt from: misba7
Repo: JanssenProject/jans PR: 12995
File: docs/janssen-server/install/helm-install/google-gke.md:110-119
Timestamp: 2026-01-13T17:29:21.837Z
Learning: In documentation, update references to ingress-nginx (kubernetes/ingress-nginx) to reflect its retirement: Kubernetes announced a terminal maintenance window through March 2026 with no further releases, bug fixes, or security updates after that. Treat ingress-nginx as retired or legacy in docs, and clearly denote current status and end-of-life timelines where relevant.

Learnt from: yuriyz
Repo: JanssenProject/jans PR: 13429
File: docs/janssen-server/auth-server/client-management/client-configuration.md:38-38
Timestamp: 2026-03-06T09:40:20.648Z
Learning: Documentation: In docs related to client configuration, clearly state that native app clients may allow any URI scheme for redirect URIs (including javascript:, data:, etc.), while web clients must use HTTPS with a non-blank host or HTTP limited to localhost/127.0.0.1. Emphasize that this behavior aligns with RFC 8252 (OAuth 2.0 for Native Apps) and that documentation should not flag the “any scheme allowed for native client” approach as incorrect.

Learnt from: olehbozhok
Repo: JanssenProject/jans PR: 13544
File: docs/cedarling/quick-start/cedarling-quick-start.md:312-329
Timestamp: 2026-03-20T19:07:30.490Z
Learning: In this repo’s MkDocs markdown documentation, do not add blank lines around fenced code blocks when the fenced block is nested inside a numbered list item (the fence is indented as part of the list item, e.g., typically by 3+ spaces). Adding blank lines can break Markdown list continuation in MkDocs and cause the following paragraph to detach from the list item. In this specific list-nested/fenced-block scenario, do not flag markdownlint’s MD031 (“fenced code blocks should be surrounded by blank lines”).

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

Labels

area-documentation Documentation needs to change as part of issue or PR comp-docs Touching folder /docs kind-bug Issue or PR is a bug in existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix: EOL docs to align the dates

2 participants