Skip to content

fix(docs): EOL docs to align dates#13570

Closed
ossdhaval wants to merge 6 commits intomainfrom
fix-docs-EOL
Closed

fix(docs): EOL docs to align dates#13570
ossdhaval wants to merge 6 commits intomainfrom
fix-docs-EOL

Conversation

@ossdhaval
Copy link
Copy Markdown
Contributor

@ossdhaval ossdhaval commented Mar 24, 2026

closes #13568

Summary by CodeRabbit

  • Documentation
    • Updated version lifecycle and support timelines in End of Life documentation
    • Extended v1.x end-of-life (support) date to 2026-11-14 (projected) while keeping it Active
    • Removed the v2.x row from the lifecycle table
    • Clarified that GA-based lifecycle calculations apply to versions 2.0.0 and later
    • Renamed header to "Version Status" and refined milestone wording to distinguish full vs. maintenance support

Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
@ossdhaval ossdhaval requested review from manojs1978 and moabu March 24, 2026 13:21
@ossdhaval ossdhaval self-assigned this Mar 24, 2026
@ossdhaval ossdhaval added the area-documentation Documentation needs to change as part of issue or PR label Mar 24, 2026
@mo-auto
Copy link
Copy Markdown
Member

mo-auto commented Mar 24, 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 Mar 24, 2026

📝 Walkthrough

Walkthrough

Updated docs/EOL.md: clarified that GA-based lifecycle calculations apply starting with version 2.0.0; renamed "Active Version Status" to "Version Status"; refined Key Milestones wording; removed the v2.x.x row; updated v1.x.0 EOL (Support) to 2026-11-14 (Projected); v1.0.x unchanged.

Changes

Cohort / File(s) Summary
Documentation
docs/EOL.md
Clarified lifecycle calculations apply to 2.0.0 and later; renamed header to "Version Status"; refined milestone wording (EOM/EOL distinctions); removed v2.x.x row; updated v1.x.0 EOL (Support) to 2026-11-14 (Projected); v1.0.x unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

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

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description only contains 'closes #13568' and is missing required sections including Implementation Details, testing checklist items, and documentation confirmation checkbox. Expand the description to include Implementation Details explaining the EOL date changes, and complete the Test and Document checklist sections.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix(docs): EOL docs to align dates' directly and clearly summarizes the main change: updating EOL documentation to align dates.
Linked Issues check ✅ Passed The PR changes align with issue #13568 by updating the EOL documentation to correct and align EOL dates with actual release dates as required.
Out of Scope Changes check ✅ Passed All changes in docs/EOL.md are focused on updating EOL dates and milestone descriptions to align with actual release dates, staying within the scope of issue #13568.
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-docs-EOL

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 the comp-docs Touching folder /docs label Mar 24, 2026
@ossdhaval ossdhaval changed the title Fix docs eol fix(docs): EOL docs to align dates Mar 24, 2026
@mo-auto mo-auto added the kind-bug Issue or PR is a bug in existing functionality label Mar 24, 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: 3

🤖 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: Replace the awkward sentence "This is applicable for version 2.0.0
and later releases." with a clearer phrasing such as "This applies to version
2.0.0 and later; earlier releases follow the legacy lifecycle." so it reads
smoothly and explicitly labels older versions as the "legacy lifecycle."
- Line 30: The table row for "v2.x.x" currently uses the GA column to show
"**Under development**", which presents a future date as an actual release;
update the cell for the v2.x.x row (the row containing the "v2.x.x" identifier
and the GA column) to use a forward-looking label such as "**Planned GA**" (or
similar) instead of "**Under development**" so the table clearly indicates this
is a planned/future GA rather than an actual release.
- Line 31: The table row for release identifier "v1.x.0" incorrectly shows
status "Active" despite EOM being 2025-04-10; update the status cell for
"v1.x.0" to reflect the maintenance phase (e.g., "Maintenance" or
"Maintenance-only") so the support status matches the documented EOM date and
expectations for bug-fix support.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: fdf34b41-add9-492f-9618-1c4a3e00d57d

📥 Commits

Reviewing files that changed from the base of the PR and between 73d9de4 and c74aed2.

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

Comment thread docs/EOL.md Outdated
## 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 is applicable for version 2.0.0 and later releases.
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.

⚠️ Potential issue | 🟡 Minor

Clarify scope sentence for readability and precision.

“This is applicable for…” is awkward; use “This applies to version 2.0.0 and later” and explicitly call older versions “legacy lifecycle” to avoid interpretation drift.

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

In `@docs/EOL.md` at line 12, Replace the awkward sentence "This is applicable for
version 2.0.0 and later releases." with a clearer phrasing such as "This applies
to version 2.0.0 and later; earlier releases follow the legacy lifecycle." so it
reads smoothly and explicitly labels older versions as the "legacy lifecycle."

Comment thread docs/EOL.md Outdated
|------------|-------------------|--------------------|-----------------------|-----------------------|
| **v2.x.x** | 2026-04-10 | 2027-04-10 | 2028-04-10 | **Under development** |
| **v1.x.0** | 2024-03-14 | 2025-04-10 | 2026-03-14 | **Active** |
| **v2.x.x** | 2026-05-01 | 2027-05-01 | 2028-05-01 | **Under development** |
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.

⚠️ Potential issue | 🟠 Major

Avoid labeling a future date as an actual GA release date.

v2.x.x is marked Under development, but the column is “Release Date (GA)”. If GA is in the future, this should be labeled as Planned GA (or similar) to avoid presenting forecast data as an actual release milestone.

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

In `@docs/EOL.md` at line 30, The table row for "v2.x.x" currently uses the GA
column to show "**Under development**", which presents a future date as an
actual release; update the cell for the v2.x.x row (the row containing the
"v2.x.x" identifier and the GA column) to use a forward-looking label such as
"**Planned GA**" (or similar) instead of "**Under development**" so the table
clearly indicates this is a planned/future GA rather than an actual release.

Comment thread docs/EOL.md Outdated
| **v2.x.x** | 2026-04-10 | 2027-04-10 | 2028-04-10 | **Under development** |
| **v1.x.0** | 2024-03-14 | 2025-04-10 | 2026-03-14 | **Active** |
| **v2.x.x** | 2026-05-01 | 2027-05-01 | 2028-05-01 | **Under development** |
| **v1.x.0** | 2024-03-14 | 2025-04-10 | 2026-11-14 | **Active** |
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.

⚠️ Potential issue | 🟠 Major

Status should reflect maintenance phase after EOM.

For v1.x.0, EOM is 2025-04-10, so by the documented support model this version is in maintenance-only support. “Active” is too broad and can mislead users about bug-fix expectations.

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

In `@docs/EOL.md` at line 31, The table row for release identifier "v1.x.0"
incorrectly shows status "Active" despite EOM being 2025-04-10; update the
status cell for "v1.x.0" to reflect the maintenance phase (e.g., "Maintenance"
or "Maintenance-only") so the support status matches the documented EOM date and
expectations for bug-fix support.

Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
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

♻️ Duplicate comments (2)
docs/EOL.md (2)

30-30: ⚠️ Potential issue | 🟠 Major

Update v1.x.0 status to reflect post-EOM phase.

Line 30 still marks v1.x.0 as Active even though EOM is 2025-04-10; this is misleading for support expectations and should be Maintenance (or Maintenance-only).

🛠️ Suggested edit
-| **v1.x.0** | 2024-03-14        | 2025-04-10         | 2026-11-14 (Projected)| **Active**            |
+| **v1.x.0** | 2024-03-14        | 2025-04-10         | 2026-11-14 (Projected)| **Maintenance**       |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/EOL.md` at line 30, The table row for the release labeled "v1.x.0" still
shows the Status as "Active" despite EOM date 2025-04-10; update that row (the
"v1.x.0" entry) to set the Status column to "Maintenance" or "Maintenance-only"
to reflect post-EOM support expectations and ensure the rendered table matches
the EOM date.

12-12: ⚠️ Potential issue | 🟡 Minor

Tighten lifecycle scope wording for clarity.

Line 12 phrasing (“This is applicable for...”) is awkward; prefer a direct statement that clearly separates 2.x+ from legacy versions.

✍️ Suggested edit
-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 is applicable for version 2.0.0 and later releases.
+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 from its original **General Availability (GA)** date. This applies to version 2.0.0 and later releases; earlier versions follow the legacy lifecycle.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/EOL.md` at line 12, Reword the awkward sentence "This is applicable for
version 2.0.0 and later releases." to a direct, unambiguous statement clarifying
scope: replace it with something like "This policy applies to major versions
2.0.0 and later; legacy versions prior to 2.0.0 follow their previous lifecycle
rules." Keep the surrounding references to "General Availability (GA)" intact so
the lifecycle calculation based on the GA date remains clear.
🤖 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 20: Update the misspelled word in the EOL milestone table row: find the
cell containing the text "End of maintenence support." and correct "maintenence"
to "maintenance" so it reads "End of maintenance support."; ensure the
surrounding formatting and spacing of the Markdown table row (including the
"$T_0 + 24$ Months" column) remain unchanged.

---

Duplicate comments:
In `@docs/EOL.md`:
- Line 30: The table row for the release labeled "v1.x.0" still shows the Status
as "Active" despite EOM date 2025-04-10; update that row (the "v1.x.0" entry) to
set the Status column to "Maintenance" or "Maintenance-only" to reflect post-EOM
support expectations and ensure the rendered table matches the EOM date.
- Line 12: Reword the awkward sentence "This is applicable for version 2.0.0 and
later releases." to a direct, unambiguous statement clarifying scope: replace it
with something like "This policy applies to major versions 2.0.0 and later;
legacy versions prior to 2.0.0 follow their previous lifecycle rules." Keep the
surrounding references to "General Availability (GA)" intact so the lifecycle
calculation based on the GA date remains clear.
🪄 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: 1b72ac47-9032-4dfa-9b01-d6fca091fb1a

📥 Commits

Reviewing files that changed from the base of the PR and between c74aed2 and da2ad73.

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

Comment thread docs/EOL.md Outdated
ossdhaval and others added 2 commits April 15, 2026 03:50
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
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.

♻️ Duplicate comments (2)
docs/EOL.md (2)

30-30: ⚠️ Potential issue | 🟠 Major

Status label conflicts with the documented support phase.

Line 30 marks v1.x.0 as Active, but its EOM is 2025-04-10, which indicates maintenance-only support rather than active/full support.

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

In `@docs/EOL.md` at line 30, Update the status label for the v1.x.0 entry so it
matches its documented end-of-maintenance date (EOM 2025-04-10); replace the
conflicting "Active" label for "v1.x.0" with a maintenance-appropriate label
such as "Maintenance" or "Maintenance-only" and ensure the table row for
"v1.x.0" clearly reflects maintenance-phase support consistent with the EOM
column.

12-12: ⚠️ Potential issue | 🟡 Minor

Clarify the lifecycle scope sentence.

Line 12 still reads awkwardly (“This is applicable for…”). Prefer a direct form like “This applies to version 2.0.0 and later; earlier releases follow the legacy lifecycle.”

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

In `@docs/EOL.md` at line 12, Replace the awkward sentence "This is applicable for
version 2.0.0 and later releases." with a clearer, direct form; update the line
in the EOL.md paragraph so it reads something like: "This applies to version
2.0.0 and later; earlier releases follow the legacy lifecycle." Ensure the new
sentence keeps the same context about GA-based lifecycle calculation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/EOL.md`:
- Line 30: Update the status label for the v1.x.0 entry so it matches its
documented end-of-maintenance date (EOM 2025-04-10); replace the conflicting
"Active" label for "v1.x.0" with a maintenance-appropriate label such as
"Maintenance" or "Maintenance-only" and ensure the table row for "v1.x.0"
clearly reflects maintenance-phase support consistent with the EOM column.
- Line 12: Replace the awkward sentence "This is applicable for version 2.0.0
and later releases." with a clearer, direct form; update the line in the EOL.md
paragraph so it reads something like: "This applies to version 2.0.0 and later;
earlier releases follow the legacy lifecycle." Ensure the new sentence keeps the
same context about GA-based lifecycle calculation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 3a5a7c60-9b86-48fe-8718-cb37148925c7

📥 Commits

Reviewing files that changed from the base of the PR and between da2ad73 and 14499a8.

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

Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
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.

♻️ Duplicate comments (1)
docs/EOL.md (1)

30-30: ⚠️ Potential issue | 🟠 Major

v1.x.0 row is inconsistent with the documented lifecycle model.

Given GA = 2024-03-14, $T_0 + 24$ Months implies EOL 2026-03-14, not 2026-11-14 (Projected). Also, with EOM already at 2025-04-10, status should reflect maintenance phase rather than broad Active.

Suggested fix
-| **v1.x.0** | 2024-03-14        | 2025-04-10         | 2026-11-14 (Projected)| **Active**            |
+| **v1.x.0** | 2024-03-14        | 2025-04-10         | 2026-03-14            | **Maintenance**       |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/EOL.md` at line 30, The v1.x.0 table row entry ("| **v1.x.0** |
2024-03-14        | 2025-04-10         | 2026-11-14 (Projected)| **Active**     
|") is inconsistent with the lifecycle rules: change the EOL date from
"2026-11-14 (Projected)" to "2026-03-14" (GA + 24 months) and update the status
from "**Active**" to "**Maintenance**" to reflect that EOM has passed; ensure
the edited row preserves the same column separators and formatting as the
surrounding table.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@docs/EOL.md`:
- Line 30: The v1.x.0 table row entry ("| **v1.x.0** | 2024-03-14        |
2025-04-10         | 2026-11-14 (Projected)| **Active**            |") is
inconsistent with the lifecycle rules: change the EOL date from "2026-11-14
(Projected)" to "2026-03-14" (GA + 24 months) and update the status from
"**Active**" to "**Maintenance**" to reflect that EOM has passed; ensure the
edited row preserves the same column separators and formatting as the
surrounding table.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: c8ae67db-6bd4-4899-aaab-7b0138d63dc9

📥 Commits

Reviewing files that changed from the base of the PR and between 14499a8 and 2d96ebb.

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

@ossdhaval
Copy link
Copy Markdown
Contributor Author

Closing this PR due to an unverified commit. Substituted by #13830 .

@ossdhaval ossdhaval closed this Apr 16, 2026
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