From b94ea3d89c0c49a63f8584edcb905a3dfa45457b Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Thu, 20 Mar 2025 16:07:44 -0500 Subject: [PATCH] Updates navigation titles and descriptions for release notes --- docs/release-notes/breaking-changes.md | 8 ++------ docs/release-notes/deprecations.md | 8 +++----- docs/release-notes/index.md | 2 -- docs/release-notes/known-issues.md | 2 +- 4 files changed, 6 insertions(+), 14 deletions(-) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index fba96055e..047f7e914 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -1,14 +1,11 @@ --- -navigation_title: "Elasticsearch Ruby Client" +navigation_title: "Breaking changes" --- # Elasticsearch Ruby Client breaking changes [elasticsearch-ruby-client-breaking-changes] -Before you upgrade, carefully review the Elasticsearch Ruby Client breaking changes and take the necessary steps to mitigate any issues. - -To learn how to upgrade, check out . +Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elasticsearch Ruby Client breaking changes and take the necessary steps to mitigate any issues. To learn how to upgrade, check [Upgrade](docs-content://deploy-manage/upgrade.md). % ## Next version [elasticsearch-ruby-client-nextversion-breaking-changes] -% **Release date:** Month day, year % ::::{dropdown} Title of breaking change % Description of the breaking change. @@ -18,7 +15,6 @@ To learn how to upgrade, check out . % :::: % ## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes] -% **Release date:** March 25, 2025 % ::::{dropdown} Title of breaking change % Description of the breaking change. diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md index 4c27fcb8b..6de975eb8 100644 --- a/docs/release-notes/deprecations.md +++ b/docs/release-notes/deprecations.md @@ -1,14 +1,13 @@ --- -navigation_title: "Elasticsearch Ruby Client" +navigation_title: "Deprecations" --- # Elasticsearch Ruby Client deprecations [elasticsearch-ruby-client-deprecations] -Review the deprecated functionality for your Elasticsearch Ruby Client version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. +Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications. -To learn how to upgrade, check out . +Review the deprecated functionality for Elasticsearch Ruby Client. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md). % ## Next version [elasticsearch-ruby-client-versionnext-deprecations] -% **Release date:** Month day, year % ::::{dropdown} Deprecation title % Description of the deprecation. @@ -18,7 +17,6 @@ To learn how to upgrade, check out . % :::: % ## 9.0.0 [elasticsearch-ruby-client-900-deprecations] -% **Release date:** March 25, 2025 % ::::{dropdown} Deprecation title % Description of the deprecation. diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index c2d13a705..f4c2258fb 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -11,7 +11,6 @@ To check for security updates, go to [Security announcements for the Elastic sta % Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections. % ## version.next [elasticsearch-ruby-client-next-release-notes] -% **Release date:** Month day, year % ### Features and enhancements [elasticsearch-ruby-client-next-features-enhancements] % * @@ -20,7 +19,6 @@ To check for security updates, go to [Security announcements for the Elastic sta % * ## 9.0.0 [elasticsearch-ruby-client-900-release-notes] -**Release date:** March 25, 2025 ### Features and enhancements [elasticsearch-ruby-client-900-features-enhancements] diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index 91ff1765d..c84a5bea5 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -1,5 +1,5 @@ --- -navigation_title: "Elasticsearch Ruby Client" +navigation_title: "Known issues" ---