Skip to content
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.

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

[doc] Releases format and minor reorg #25466

Merged
merged 2 commits into from
Jan 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
45 changes: 23 additions & 22 deletions docs/config/_default/menus.toml
Original file line number Diff line number Diff line change
Expand Up @@ -818,32 +818,16 @@

[[preview_releases]]
name = "Releases"
weight = 2
weight = 1
identifier = "releases"
url = "/preview/releases/"
[preview_releases.params]
classes = "separator"
showSection = true

[[preview_releases]]
name = "Versioning"
weight = 3
identifier = "release-versioning"
url = "/preview/releases/versioning/"
[preview_releases.params]
showSection = true

[[preview_releases]]
name = "Tech Advisories"
weight = 4
identifier = "tech-advisories"
url = "/preview/releases/techadvisories/"
[preview_releases.params]
showSection = true

[[preview_releases]]
name = "YugabyteDB"
weight = 5
weight = 2
identifier = "ybdb-releases"
url = "/preview/releases/ybdb-releases/"
[preview_releases.params]
Expand All @@ -859,37 +843,54 @@

[[preview_releases]]
name = "YugabyteDB Anywhere"
weight = 6
weight = 3
identifier = "yba-releases"
url = "/preview/releases/yba-releases/"
[preview_releases.params]
showSection = true

[[preview_releases]]
name = "YugabyteDB Aeon"
weight = 10
weight = 4
identifier = "ybm-releases"
url = "/preview/yugabyte-cloud/release-notes/"
[preview_releases.params]
showSection = true

[[preview_releases]]
name = "YugabyteDB Voyager"
weight = 11
weight = 5
identifier = "voy-releases"
url = "/preview/yugabyte-voyager/release-notes/"
[preview_releases.params]
showSection = true
imageUrl = "/images/migrate/migration-icon.svg"

[[preview_releases]]
name = "YugabyteDB Clients"
weight = 7
weight = 6
identifier = "yb-clients"
url = "/preview/releases/yugabyte-clients/"
[preview_releases.params]
classes = "separator"
showSection = true

[[preview_releases]]
name = "Versioning"
weight = 10
identifier = "release-versioning"
url = "/preview/releases/versioning/"
[preview_releases.params]
showSection = true

[[preview_releases]]
name = "Tech Advisories"
weight = 11
identifier = "tech-advisories"
url = "/preview/releases/techadvisories/"
[preview_releases.params]
showSection = true

########## Menus (in preview) for FAQ section

# [[preview_faq]]
Expand Down
22 changes: 1 addition & 21 deletions docs/content/preview/releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,26 +43,6 @@ Preview releases, which include features under active development are recommende

For details about the differences between the release series, see [Release versioning](versioning/).

### Stable Release support policy

For Stable releases, the LTS or STS designation determines its support timelines.

**LTS** release series receive maintenance updates for at least 2 years (730 days) from the first release date of the minor release. Extended support (defined below) is provided for an additional 180 days. As a result, 2.5 years of support is provided in total.

**STS** release series receive maintenance updates for at least 1 year (365 days) from the first release date of the minor release. Extended support (defined below) is provided for an additional 180 days. As a result, 1.5 years of support is provided in total.

- **Extended support:** Following the maintenance update period, Yugabyte will provide support for at least an additional 180 days subject to the following guidelines:
- Updates and Upgrades will not be made to the minor release.
- Yugabyte will direct Customers to existing Updates and workarounds applicable to the reported case.
- Yugabyte may direct Customers to Upgrade to a current release if a workaround does not exist.
- **End of Life (EOL):** Yugabyte will post publicly on its website a notice of End of Life (EOL) for the affected Software and the timeline for discontinuing Support Services.

{{<note title="Archived docs available">}}
Documentation for EOL stable releases is available at the [YugabyteDB docs archive](https://docs-archive.yugabyte.com/).
{{</note>}}

The information in this section is a summary for convenience only. For complete details, see the [Yugabyte Support Services Agreement](https://www.yugabyte.com/yugabyte-software-support-services-agreement/).

## Upcoming release series

The table below includes tentative release dates for upcoming release series, subject to change.
Expand All @@ -71,7 +51,7 @@ For information on key features planned for the upcoming releases, visit [Curren

| Release series | Planned release |
| :------------- | :-------------- |
| Next LTS | End 2024 |
| Next STS | Mid 2025 |

## Recommended release series for projects

Expand Down
36 changes: 29 additions & 7 deletions docs/content/preview/releases/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ YugabyteDB and YugabyteDB Anywhere have three kinds of releases:
- Stable, with Standard-term support (STS)
- Preview, with no official support

Additionally, individual features may also be designated as tech preview or early access, or generally available. These designations indicate the feature maturity level, and provide different levels of documentation and support as described in [Feature maturity](#feature-maturity).
Additionally, individual features may also be designated as tech preview or early access, or generally available. These designations indicate the feature maturity level, and provide different levels of documentation and support as described in [Feature maturity](#feature-maturity).

## Stable releases

Expand All @@ -38,11 +38,32 @@ On rare occasions, YugabyteDB may issue a hot fix release. Hot fix releases are

{{< note title="Important" >}}

- Yugabyte supports _production deployments_ on stable YugabyteDB releases and upgrades to newer stable releases. For a list of releases and their support timelines, see [YugabyteDB releases](../ybdb-releases/) and [YugabyteDB Anywhere releases](../yba-releases/).
- For recommendations on which version to use for development and testing, see [Recommended release series for projects](../../releases/#recommended-release-series-for-projects).
Yugabyte supports _production deployments_ on stable YugabyteDB releases, and upgrades to newer stable releases.

For a list of releases and their support timelines, see [YugabyteDB releases](../ybdb-releases/) and [YugabyteDB Anywhere releases](../yba-releases/).

{{< /note >}}

### Stable Release support policy

For Stable releases, the LTS or STS designation determines its support timelines.

**LTS** release series receive maintenance updates for at least 2 years (730 days) from the first release date of the minor release. Extended support (defined below) is provided for an additional 180 days. As a result, 2.5 years of support is provided in total.

**STS** release series receive maintenance updates for at least 1 year (365 days) from the first release date of the minor release. Extended support (defined below) is provided for an additional 180 days. As a result, 1.5 years of support is provided in total.

- **Extended support:** Following the maintenance update period, Yugabyte will provide support for at least an additional 180 days subject to the following guidelines:
- Updates and Upgrades will not be made to the minor release.
- Yugabyte will direct Customers to existing Updates and workarounds applicable to the reported case.
- Yugabyte may direct Customers to Upgrade to a current release if a workaround does not exist.
- **End of Life (EOL):** Yugabyte will post publicly on its website a notice of End of Life (EOL) for the affected Software and the timeline for discontinuing Support Services.

{{<note title="Archived docs available">}}
Documentation for EOL stable releases is available at the [YugabyteDB docs archive](https://docs-archive.yugabyte.com/).
{{</note>}}

The information in this section is a summary for convenience only. For complete details, see the [Yugabyte Support Services Agreement](https://www.yugabyte.com/yugabyte-software-support-services-agreement/).

## Preview releases

Features in preview releases are considered to be {{<tags/feature/tp>}} unless marked otherwise.
Expand All @@ -64,8 +85,9 @@ Preview releases use the numbering format `MAJOR.MINOR.PATCH.HOTFIX`, where non-

{{< note title="Note" >}}

- The preview release series is not supported for production deployments.
- There is currently no migration path from a preview release to a stable release.
The preview release series is not supported for production deployments.

There is currently no migration path from a preview release to a stable release.

{{< /note >}}

Expand Down Expand Up @@ -110,7 +132,7 @@ Documentation (if provided) for TP features is marked as such.

A feature in Early Access (EA) is new or enhanced functionality made available for you to use.

EA features are supported by Yugabyte Support, and issues are addressed according to the [stable release support policy](../#stable-release-support-policy).
EA features are supported by Yugabyte Support, and issues are addressed according to the [stable release support policy](#stable-release-support-policy).

Code is well tested. Typically these features are not enabled by default. Enabling the feature is considered safe.

Expand All @@ -130,7 +152,7 @@ Documentation for EA features is marked as such.

A feature in General Availability (GA) is enabled and accessible by default for all customers.

GA features are supported by Yugabyte Support, and issues are addressed according to the [stable release support policy](../#stable-release-support-policy).
GA features are supported by Yugabyte Support, and issues are addressed according to the [stable release support policy](#stable-release-support-policy).

Any feature not marked Tech Preview or Early Access should be considered GA.

Expand Down
2 changes: 1 addition & 1 deletion docs/content/preview/releases/yba-releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ YugabyteDB Anywhere will end support for Replicated installation at the **end of

For end-of-life releases, see [Releases at end of life](../ybdb-releases/#eol-releases).

For information on stable release support policy, see [Stable Release support policy](../#stable-release-support-policy).
For information on stable release support policy, see [Stable Release support policy](../versioning/#stable-release-support-policy).

For information on release versioning, see [Versioning](../versioning/).

Expand Down
22 changes: 11 additions & 11 deletions docs/content/preview/releases/ybdb-releases/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ cascade:
Starting with v2.16, the [release notes for YugabyteDB Anywhere](../yba-releases/) have moved to their own page.
{{< /tip >}}

For information on stable release support policy, see [Stable Release support policy](../#stable-release-support-policy).
For information on stable release support policy, see [Stable Release support policy](../versioning/#stable-release-support-policy).

For information on release versioning, see [Versioning](../versioning/).

Expand All @@ -40,19 +40,19 @@ The following stable and preview releases are no longer supported:

| Release series | Released | End of maintenance support | End of Life (EOL) |
| :------------- | :------- | :------------------------- | :---------------- |
| [v2.21](v2.21/) | March 26, 2024 | n/a | n/a |
| [v2.19](v2.19/) | March 8, 2024 | n/a | n/a |
| [v2.17](v2.17/) | December 8, 2022 | n/a | n/a |
| [v2.16](end-of-life/v2.16/) | December 14, 2022 | December 14, 2023 | June 14, 2024 |
| [v2.15](v2.15/) | June 27, 2022 | n/a | n/a |
| [v2.13](end-of-life/v2.13/) | March 7, 2022 | n/a | n/a |
| [v2.21](v2.21/) {{<tags/release/preview>}} | March 26, 2024 | n/a | n/a |
| [v2.19](v2.19/) {{<tags/release/preview>}} | June 20, 2023 | n/a | n/a |
| [v2.17](v2.17/) {{<tags/release/preview>}} | December 8, 2022 | n/a | n/a |
| [v2.16](end-of-life/v2.16/) {{<tags/release/sts>}} | December 14, 2022 | December 14, 2023 | June 14, 2024 |
| [v2.15](v2.15/) {{<tags/release/preview>}} | June 27, 2022 | n/a | n/a |
| [v2.13](end-of-life/v2.13/) {{<tags/release/preview>}} | March 7, 2022 | n/a | n/a |
| [v2.12](end-of-life/v2.12/) | February 22, 2022 | February 22, 2023 | August 22, 2023 |
| [v2.11](end-of-life/v2.11/) | November 22, 2021 | n/a | n/a |
| [v2.9](end-of-life/v2.9/) | August 31, 2021 | n/a | n/a |
| [v2.11](end-of-life/v2.11/) {{<tags/release/preview>}} | November 22, 2021 | n/a | n/a |
| [v2.9](end-of-life/v2.9/) {{<tags/release/preview>}} | August 31, 2021 | n/a | n/a |
| [v2.8](end-of-life/v2.8/) | November 15, 2021 | November 15, 2022 | May 15, 2023 |
| [v2.7](end-of-life/v2.7/) | May 5, 2021 | n/a | n/a |
| [v2.7](end-of-life/v2.7/) {{<tags/release/preview>}} | May 5, 2021 | n/a | n/a |
| [v2.6](end-of-life/v2.6/) | July 5, 2021 | July 5, 2022 | January 5, 2023 |
| [v2.5](end-of-life/v2.5/) | November 12, 2020 | n/a | n/a |
| [v2.5](end-of-life/v2.5/) {{<tags/release/preview>}} | November 12, 2020 | n/a | n/a |
| [v2.4](end-of-life/v2.4/) | January 22, 2021 | January 22, 2022 | July 21, 2022 |
| [v2.2](end-of-life/v2.2/) | July 15, 2020 | July 15, 2021 | January 15, 2022 |
| [v2.1](end-of-life/v2.1/) | February 25, 2020 | February 25, 2021 | August 08, 2021 |
Expand Down
1 change: 0 additions & 1 deletion docs/content/preview/releases/ybdb-releases/v2.23.md
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,6 @@ We've improved the performance of backward scans by 10x. For example, descending
* Avoids failure when upgrading from version 2.14/2.16 to 2.20 by introducing a check to ensure pggate can handle RPC metrics sidecar before sending Scanned Rows count. {{<issue 21229>}}
* Fixes memory leaks in pg_constraint/pg_attrdef local cache by adding a missing `hash_destroy` call in `YbCleanupTupleCache`. {{<issue 22262>}}
* Resolves remaining memory leaks in CacheMemoryContext to stabilize cache memory after every catalog cache refresh. {{<issue 22262>}}
* Documents the limitations of retry logic when using `-c` flag in ysqlsh command. {{<issue 21804>}}
* Allows YSQL DDL operations to wait for rollback/roll-forward operations to finish before proceeding. {{<issue 20033>}}
* Allows more accurate modeling of base scan costs by taking into account the impact of storage index filters on secondary index. {{<issue 20635>}}
* Resolves colocation option issues in table creation linked to table rewriting and partitioning. Enhances the `defGetBoolean` function to parse string values "0" and "1" as false and true respectively, and shifts a verification step to a earlier spot in the CREATE TABLE execution path, ensuring successful table partition creation. {{<issue 20302>}},{{<issue 20914>}}
Expand Down
1 change: 0 additions & 1 deletion docs/content/preview/releases/ybdb-releases/v2024.2.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,7 +292,6 @@ The performance of YSQL backward table scans (for example, a descending-sorted q
* Eliminates memory leaks in the YSQL cache system for improved database stability. {{<issue 22262>}}
* Fixes memory leak affecting catalog cache refresh during upgrades. {{<issue 22262>}}
* Fixes memory leaks in `CacheMemoryContext` to stabilize cache memory size after refresh. {{<issue 22262>}}
* Documents the limitation in retry logic for multi-statement queries in ysqlsh. {{<issue 21804>}}
* Prevents YSQL DDL operations from returning control until related rollbacks complete. {{<issue 20033>}}
* Enhances index scan efficiency by modeling remote index filters in cost calculations. {{<issue 20635>}}
* Fixes issues with colocation in table rewrites and partitions. {{<issue 20302>}},{{<issue 20914>}}
Expand Down