Skip to content

Updates navigation titles and descriptions for release notes #966

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

Merged
merged 1 commit into from
Mar 21, 2025
Merged

Updates navigation titles and descriptions for release notes #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 2 additions & 6 deletions docs/release-notes/breaking-changes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
navigation_title: "Elasticsearch Java Client"
navigation_title: "Breaking changes"
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/breaking-changes-policy.html
---

# Elasticsearch Java Client breaking changes [elasticsearch-java-client-breaking-changes]
Before you upgrade, carefully review the Elasticsearch Java Client breaking changes and take the necessary steps to mitigate any issues.

To learn how to upgrade, check out <uprade docs>.
Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elasticsearch Java 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).

## Breaking changes policy [elasticsearch-java-client-breaking-changes-policy]
The Java API Client source code is generated from a [formal specification of the Elasticsearch API](https://github.com/elastic/elasticsearch-specification). This API specification is large, and although it is tested against hundreds of Elasticsearch test files, it may have discrepancies with the actual API that result in issues in the Java API Client.
Expand All @@ -31,7 +29,6 @@ Major releases (e.g. 7.x → 8.x) can include larger refactorings of the API spe
All Elasticsearch APIs have stability indicators, which imply potential changes. If an API is `stable` only additional non-breaking changes are added. In case of `experimental` APIs, breaking changes can be introduced any time, which means that these changes, will also be reflected in the Java API Client.

% ## Next version [elasticsearch-java-client-versionnext-breaking-changes]
% **Release date:** Month day, year

% ::::{dropdown} Title of breaking change
% Description of the breaking change.
Expand All @@ -41,7 +38,6 @@ All Elasticsearch APIs have stability indicators, which imply potential changes.
% ::::

% ## 9.0.0 [elasticsearch-java-client-900-breaking-changes]
% **Release date:** March 25, 2025

% ::::{dropdown} Title of breaking change
% Description of the breaking change.
Expand Down
8 changes: 3 additions & 5 deletions docs/release-notes/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
navigation_title: "Elasticsearch Java Client"
navigation_title: "Deprecations"
---
# Elasticsearch Java Client deprecations [elasticsearch-java-client-deprecations]
Review the deprecated functionality for your Elasticsearch Java 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 <uprade docs>.
Review the deprecated functionality for Elasticsearch Java 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
% **Release date:** Month day, year

% ::::{dropdown} Deprecation title
% Description of the deprecation.
Expand All @@ -17,7 +16,6 @@ To learn how to upgrade, check out <uprade docs>.
% ::::

% ## 9.0.0 [elasticsearch-java-client-900-deprecations]
% **Release date:** March 25, 2025

% ::::{dropdown} Deprecation title
% Description of the deprecation.
Expand Down
2 changes: 0 additions & 2 deletions docs/release-notes/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [felasticsearch-java-client-next-release-notes]
% **Release date:** Month day, year

% ### Features and enhancements [elasticsearch-java-client-next-features-enhancements]
% *
Expand All @@ -20,7 +19,6 @@ To check for security updates, go to [Security announcements for the Elastic sta
% *

## 9.0.0 [elasticsearch-java-client-900-release-notes]
**Release date:** March 25, 2025

### Features and enhancements [elasticsearch-java-client-900-features-enhancements]

Expand Down
2 changes: 1 addition & 1 deletion docs/release-notes/known-issues.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
navigation_title: "Elasticsearch Java Client"
navigation_title: "Known issues"

---

Expand Down
Loading