Conversation
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdded a new documentation page that defines the project's version end-of-life (EOL) policy and linked it in the site navigation; removed the repository's changelog file Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
mo-auto
added
the
area-documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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/install/eol.md`:
- Line 8: Replace the top-level H1 heading "# Version EOL Policy" with an H2 by
changing the leading "#" to "##" so the document uses the repository's H2-first
docs convention; ensure no other H1 headings precede content and update any
anchor references if they depend on the original heading text.
- Line 51: The Markdown link "[Changelog](CHANGELOG.md)" in docs/install/eol.md
points to docs/install/CHANGELOG.md (non-existent); update the link target to
"../CHANGELOG.md" so it correctly references docs/CHANGELOG.md by replacing the
existing "[Changelog](CHANGELOG.md)" occurrence with
"[Changelog](../CHANGELOG.md)".
- Line 53: Replace the hard-to-parse sentence "*Automated Upgrade Scripts:*
Available for versions the last three releases..." in docs/install/eol.md with a
clearer sentence that states automated upgrade scripts are provided for the
three previous releases and shows the sequential example; e.g., "Automated
upgrade scripts are provided for upgrades from any of the three immediately
preceding releases — for example, to move from 5.14.0 to 6.0.0 run the scripts
sequentially: 5.14.0 → 5.15.0, 5.15.0 → 5.16.0, and 5.16.0 → 6.0.0." Ensure the
new wording replaces the original sentence exactly where that phrase appears.
- Around line 30-32: The status table is inconsistent: the row for **v5.x.x**
shows an EOL date of 2026-03-15 but still has the status **Active**; update that
row so the status matches the date (change the final cell in the **v5.x.x**
table row from "**Active**" to "**EOL**") and verify the surrounding rows
(**v6.0.0**, **v5.0.x**) keep their current dates/statuses unchanged.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 89cbbcd2-d14e-4cf8-9041-feb849957c1f
📒 Files selected for processing (2)
docs/install/eol.mdmkdocs.yml
docs/install/eol.md
Outdated
| | **v6.0.0** | 2026-04-20 | 2027-04-20 | 2028-04-20 | **Under development** | | ||
| | **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **Active** | | ||
| | **v5.0.x** | 2022-03-15 | 2023-03-15 | 2024-03-15 | **EOL** | |
There was a problem hiding this comment.
Status table is currently date-inconsistent.
As of March 19, 2026, v5.x.x shows EOL as March 15, 2026 but is still labeled Active. Please update status values so they match the stated dates.
Proposed fix (minimal)
-| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **Active** |
+| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **EOL** |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/install/eol.md` around lines 30 - 32, The status table is inconsistent:
the row for **v5.x.x** shows an EOL date of 2026-03-15 but still has the status
**Active**; update that row so the status matches the date (change the final
cell in the **v5.x.x** table row from "**Active**" to "**EOL**") and verify the
surrounding rows (**v6.0.0**, **v5.0.x**) keep their current dates/statuses
unchanged.
There was a problem hiding this comment.
I had the same concern with the Jans PR here. You did respond but can you clarify again here. Question is, if we follow the 12-month calculation from the release date, there will be gaps where no version is active. For instance, here there is a gap between EOM of 5.x.x (2025-03-15) and release date of 6.0. I think we could be flexible with the dates to fix this. What do you suggest?
There was a problem hiding this comment.
Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
docs/install/eol.md (1)
31-31:⚠️ Potential issue | 🟠 MajorStatus is inconsistent with the stated EOL date.
As of March 19, 2026,
v5.x.xhas EOL 2026-03-15 but is still marked Active. Please align the status with the date.Proposed minimal fix
-| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **Active** | +| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **EOL** |🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/install/eol.md` at line 31, The table row for the release entry containing the literal string "| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 | **Active** |" has an incorrect status for the EOL date; update the final status token "**Active**" to reflect that the 2026-03-15 EOL has passed (e.g., "**EOL**" or "**End of Life**") so the row status matches the stated EOL date, ensuring the exact row string for v5.x.x is edited.
🤖 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/install/eol.md`:
- Around line 24-30: The section titled "Active Version Status" is ambiguous
because the table includes an unreleased version (v6.0.0 with GA 2026-04-20)
labeled "Under development"; rename the heading (e.g., to "Version Status") or
split into two tables "Active (Released) Versions" and "Upcoming/Under
Development Versions" and move the v6.0.0 row into the upcoming table so the
meaning of the table (and the values for "Release Date (GA)" and "Status") is
unambiguous.
- Line 52: The "Compatibility Matrix" bullet is missing a target link; update
the bullet "* **Compatibility Matrix:** Ensure your OS and hardware meet the
System Requirements for the new version." to include a concrete URL or internal
doc anchor pointing to the System Requirements page (e.g., add "(See System
Requirements: <URL-or-anchor>)"), so readers can click through directly; locate
and edit the exact bullet text "Compatibility Matrix" in the docs/install/eol.md
content.
---
Duplicate comments:
In `@docs/install/eol.md`:
- Line 31: The table row for the release entry containing the literal string "|
**v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-03-15 |
**Active** |" has an incorrect status for the EOL date; update the
final status token "**Active**" to reflect that the 2026-03-15 EOL has passed
(e.g., "**EOL**" or "**End of Life**") so the row status matches the stated EOL
date, ensuring the exact row string for v5.x.x is edited.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f5226037-6a2e-4bf1-8e06-8ebb5c3d563d
📒 Files selected for processing (1)
docs/install/eol.md
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
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/install/eol.md`:
- Line 52: Update the Compatibility Matrix bullet to correct the missing
preposition by changing "system requirements your deployment platform" to
"system requirements for your deployment platform" so the sentence reads:
"Ensure your OS and hardware meet the system requirements for your deployment
platform for the new version. Refer to the [installation](./README.md) section
for more details."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: cb3aef5b-e28d-4902-9149-2affec06a6c5
📒 Files selected for processing (1)
docs/install/eol.md
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
There was a problem hiding this comment.
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/install/eol.md`:
- Around line 16-20: The table's EOL formula ("End of Life (EOL) = $T_0 + 24$
Months") is inconsistent with the EOL dates listed for versions "v5.x.x" and
"v5.0.x"; either correct those table dates to match the formula (recalculate EOL
as GA + 24 months for the entries referencing v5.* and replace the current EOL
cells) or add an explicit exception entry below the table documenting the
exception rule (mentioning "v5.x.x" and "v5.0.x") and the reason, and ensure all
other rows still follow "End of Life (EOL) = $T_0 + 24$ Months".
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5cc771be-e719-4a2b-bd39-6822d439792d
📒 Files selected for processing (1)
docs/install/eol.md
Signed-off-by: Dhaval D <343411+ossdhaval@users.noreply.github.com>
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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/install/eol.md`:
- Around line 21-23: The EOM/EOL definitions are contradictory: update the
"**End of Maintenance (EOM)**" table row and the paragraph at lines referenced
(42-43) so they use consistent terminology — either state that EOM is the final
date when active maintenance (bug fixes and security patches) ends, or state
that maintenance support continues until EOM and then stops; apply the chosen
wording to the "**End of Maintenance (EOM)**" table cell and the explanatory
lines (currently mentioning maintenance support and bug/security fixes) so both
describe the same cutoff for fixes and documentation archival, and ensure the
"**End of Life (EOL)**" row remains the final archival/removal milestone.
- Line 16: Replace the misspelled word "cadense" with "cadence" in the lifecycle
description sentence that currently reads "The table below shows general cadense
of the key release milestones. Applicable from version `6.0.0` onwards." —
update that string to use "cadence" so it reads "The table below shows general
cadence of the key release milestones. Applicable from version `6.0.0` onwards."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: a4f5eb83-8f86-4caf-b705-bebe1b658216
📒 Files selected for processing (1)
docs/install/eol.md
|
|
||
| ### Key Milestones | ||
|
|
||
| The table below shows general cadense of the key release milestones. Applicable from version `6.0.0` onwards. |
There was a problem hiding this comment.
Fix spelling in lifecycle description.
Line 16 uses “cadense”; it should be “cadence”.
Proposed fix
-The table below shows general cadense of the key release milestones. Applicable from version `6.0.0` onwards.
+The table below shows the general cadence of key release milestones. Applicable from version `6.0.0` onward.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The table below shows general cadense of the key release milestones. Applicable from version `6.0.0` onwards. | |
| The table below shows the general cadence of key release milestones. Applicable from version `6.0.0` onward. |
🧰 Tools
🪛 LanguageTool
[grammar] ~16-~16: Ensure spelling is correct
Context: ...lestones The table below shows general cadense of the key release milestones. Applicab...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/install/eol.md` at line 16, Replace the misspelled word "cadense" with
"cadence" in the lifecycle description sentence that currently reads "The table
below shows general cadense of the key release milestones. Applicable from
version `6.0.0` onwards." — update that string to use "cadence" so it reads "The
table below shows general cadence of the key release milestones. Applicable from
version `6.0.0` onwards."
| | **End of Maintenance (EOM)** | $T_0 + 12$ Months | Final date for bug fixes and security patches. | | ||
| | **End of Life (EOL)** | $T_0 + 24$ Months | Support is no longer provided; documentation moved to archives. | | ||
|
|
There was a problem hiding this comment.
Internal policy contradiction between EOM definition and maintenance support.
Line 21 says EOM is the final date for bug/security fixes, but Lines 42-43 say those fixes continue during maintenance support. Please align terminology and definitions so lifecycle phases are unambiguous (this currently makes the version table hard to interpret).
Proposed doc alignment (minimal)
-| **End of Maintenance (EOM)** | $T_0 + 12$ Months | Final date for bug fixes and security patches. |
+| **End of Full Support (EFS)** | $T_0 + 12$ Months | Final date for full support; after this, maintenance support applies. |
| **End of Life (EOL)** | $T_0 + 24$ Months | Support is no longer provided; documentation moved to archives. |-| Version | Release Date (GA) | End of Maintenance | End of Life (Support) | Status |
+| Version | Release Date (GA) | End of Full Support | End of Life (Support) | Status |Also applies to: 42-43
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/install/eol.md` around lines 21 - 23, The EOM/EOL definitions are
contradictory: update the "**End of Maintenance (EOM)**" table row and the
paragraph at lines referenced (42-43) so they use consistent terminology —
either state that EOM is the final date when active maintenance (bug fixes and
security patches) ends, or state that maintenance support continues until EOM
and then stops; apply the chosen wording to the "**End of Maintenance (EOM)**"
table cell and the explanatory lines (currently mentioning maintenance support
and bug/security fixes) so both describe the same cutoff for fixes and
documentation archival, and ensure the "**End of Life (EOL)**" row remains the
final archival/removal milestone.
2 participants
Added EOL documentation for Flex releases
Summary by CodeRabbit