Skip to content

docs: add EOL documentation #2709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ossdhaval wants to merge 9 commits into
base: main
Choose a base branch
from
+71 −179
Open

docs: add EOL documentation #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cb5bb3a
docs: add EOL documentation
ossdhaval Mar 19, 2026
1731381
Merge branch 'main' into docs-add-eol-policy
ossdhaval Mar 19, 2026
6762056
docs: changelog should point to GH release page
ossdhaval Mar 19, 2026
1be6b9d
fix: better wording
ossdhaval Mar 19, 2026
0ed3c43
docs: update section heading
ossdhaval Mar 19, 2026
e174236
docs: fix grammar
ossdhaval Mar 19, 2026
330e6ae
docs: align EOL dates with release
ossdhaval Mar 23, 2026
f5fc79a
fix: milestone table
ossdhaval Mar 24, 2026
2209dbc
Merge branch 'main' into docs-add-eol-policy
ossdhaval Mar 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 0 additions & 179 deletions docs/CHANGELOG.md
View file
Open in desktop

This file was deleted.

70 changes: 70 additions & 0 deletions docs/install/eol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
tags:
- EOL
- Supported versions
- Version lifecycle
---

# Version EOL Policy

## 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.

### Key Milestones

The table below shows general cadense of the key release milestones. Applicable from version `6.0.0` onwards.
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 24, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
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."


| Milestone | Calculation | Description |
|-------------------------------|-------------------|---------------------------------------------------------------------|
| **General Availability (GA)** | $T_0$ | The date the version was publicly released. |
| **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. |

Comment on lines +21 to +23
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 24, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

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. Version Status

Use the table below to determine the current status of your installed version.

| Version | Release Date (GA) | End of Maintenance | End of Life (Support) | Status |
|------------|-------------------|--------------------|-----------------------|-----------------------|
| **v6.0.0** | 2026-05-01 | 2027-05-01 | 2028-05-01 | **Under development** |
| **v5.x.x** | 2024-03-15 | 2025-03-15 | 2026-11-01 | **Active** |
| **v5.0.x** | 2022-03-15 | 2023-03-15 | 2024-09-15 | **EOL** |

---

## 3. Support Scope During Transition

As a version approaches its EOL date, the level of support shifts:

* **Full Support:** Covers "How-to" questions, bug fixes, and security vulnerabilities.
* **Maintenance Support:** No new features. Only critical security patches and high-severity bug fixes are provided.

---

## 4. Upgrade & Migration Guidance

To maintain system integrity and security, we recommend upgrading to the latest Stable Release at least **six months prior** to your current version's EOL date.

### Migration Resources:

* **Breaking Changes Log:** Review our [Changelog](https://github.com/GluuFederation/flex/releases) for API or configuration changes.
* **Compatibility Matrix:** 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.
* **Automated Upgrade Scripts:** Available for the last three releases to simplify upgrades.
For example, upgrading from 5.14.0 to 6.0.0 should follow: 5.14.0 → 5.15.0 → 5.16.0 → 6.0.0.

> **Warning:** Running software past its EOL date may result in compatibility issues with newer OS updates and increased exposure to security threats.

---

## 5. Documentation Archiving

Once a version reaches its EOL date:

1. Online documentation will be moved to the **Legacy Archive**.
2. Knowledge Base articles will remain searchable but will no longer be updated.
3. Community forums for that version will be set to **Read-Only**.

---
1 change: 1 addition & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ nav:
- 'Ubuntu': 'install/vm-install/ubuntu.md'
- 'RHEL': 'install/vm-install/rhel.md'
- 'SUSE': 'install/vm-install/suse.md'
- 'Version Support Policy': 'install/eol.md'
- 'Administration':
- 'admin/README.md'
- 'Configuration': 'admin/config.md'
Expand Down
Loading