[docs] Migrate docs from AsciiDoc to Markdown (#2635)
* delete asciidoc files * add migrated files * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * Apply suggestions from review Co-authored-by: Josh Mock <josh@joshmock.com> * add the new ci checks (#2634) --------- Co-authored-by: Marci W <333176+marciw@users.noreply.github.com> Co-authored-by: Josh Mock <josh@joshmock.com>
This commit is contained in:
28
docs/release-notes/breaking-changes.md
Normal file
28
docs/release-notes/breaking-changes.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
navigation_title: "Elasticsearch JavaScript Client"
|
||||
---
|
||||
|
||||
# Elasticsearch JavaScript Client breaking changes [elasticsearch-javascript-client-breaking-changes]
|
||||
Before you upgrade, carefully review the Elasticsearch JavaScript Client breaking changes and take the necessary steps to mitigate any issues.
|
||||
|
||||
To learn how to upgrade, check out <upgrade docs>.
|
||||
|
||||
% ## Next version [elasticsearch-javascript-client-versionnext-breaking-changes]
|
||||
% **Release date:** Month day, year
|
||||
|
||||
% ::::{dropdown} Title of breaking change
|
||||
% Description of the breaking change.
|
||||
% For more information, check [PR #](PR link).
|
||||
% **Impact**<br> Impact of the breaking change.
|
||||
% **Action**<br> Steps for mitigating deprecation impact.
|
||||
% ::::
|
||||
|
||||
% ## 9.0.0 [elasticsearch-javascript-client-900-breaking-changes]
|
||||
% **Release date:** March 25, 2025
|
||||
|
||||
% ::::{dropdown} Title of breaking change
|
||||
% Description of the breaking change.
|
||||
% For more information, check [PR #](PR link).
|
||||
% **Impact**<br> Impact of the breaking change.
|
||||
% **Action**<br> Steps for mitigating deprecation impact.
|
||||
% ::::
|
||||
28
docs/release-notes/deprecations.md
Normal file
28
docs/release-notes/deprecations.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
navigation_title: "Elasticsearch JavaScript Client"
|
||||
---
|
||||
|
||||
# Elasticsearch JavaScript Client deprecations [elasticsearch-javascript-client-deprecations]
|
||||
Review the deprecated functionality for your Elasticsearch JavaScript Client version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade.
|
||||
|
||||
To learn how to upgrade, check out <uprade docs>.
|
||||
|
||||
% ## Next version
|
||||
% **Release date:** Month day, year
|
||||
|
||||
% ::::{dropdown} Deprecation title
|
||||
% Description of the deprecation.
|
||||
% For more information, check [PR #](PR link).
|
||||
% **Impact**<br> Impact of deprecation.
|
||||
% **Action**<br> Steps for mitigating deprecation impact.
|
||||
% ::::
|
||||
|
||||
% ## 9.0.0 [elasticsearch-javascript-client-900-deprecations]
|
||||
% **Release date:** March 25, 2025
|
||||
|
||||
% ::::{dropdown} Deprecation title
|
||||
% Description of the deprecation.
|
||||
% For more information, check [PR #](PR link).
|
||||
% **Impact**<br> Impact of deprecation.
|
||||
% **Action**<br> Steps for mitigating deprecation impact.
|
||||
% ::::
|
||||
27
docs/release-notes/index.md
Normal file
27
docs/release-notes/index.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
navigation_title: "Elasticsearch JavaScript Client"
|
||||
---
|
||||
|
||||
# Elasticsearch JavaScript Client release notes [elasticsearch-javascript-client-release-notes]
|
||||
|
||||
Review the changes, fixes, and more in each version of Elasticsearch JavaScript Client.
|
||||
|
||||
To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31).
|
||||
|
||||
% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
|
||||
|
||||
% ## version.next [elasticsearch-javascript-client-next-release-notes]
|
||||
% **Release date:** Month day, year
|
||||
|
||||
% ### Features and enhancements [elasticsearch-javascript-client-next-features-enhancements]
|
||||
% *
|
||||
|
||||
% ### Fixes [elasticsearch-javascript-client-next-fixes]
|
||||
% *
|
||||
|
||||
## 9.0.0 [elasticsearch-javascript-client-900-release-notes]
|
||||
**Release date:** March 25, 2025
|
||||
|
||||
### Features and enhancements [elasticsearch-javascript-client-900-features-enhancements]
|
||||
|
||||
### Fixes [elasticsearch-javascript-client-900-fixes]
|
||||
20
docs/release-notes/known-issues.md
Normal file
20
docs/release-notes/known-issues.md
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
navigation_title: "Elasticsearch JavaScript Client"
|
||||
|
||||
---
|
||||
|
||||
# Elasticsearch JavaScript Client known issues [elasticsearch-javascript-client-known-issues]
|
||||
|
||||
% Use the following template to add entries to this page.
|
||||
|
||||
% :::{dropdown} Title of known issue
|
||||
% **Details**
|
||||
% On [Month/Day/Year], a known issue was discovered that [description of known issue].
|
||||
|
||||
% **Workaround**
|
||||
% Workaround description.
|
||||
|
||||
% **Resolved**
|
||||
% On [Month/Day/Year], this issue was resolved.
|
||||
|
||||
:::
|
||||
5
docs/release-notes/toc.yml
Normal file
5
docs/release-notes/toc.yml
Normal file
@ -0,0 +1,5 @@
|
||||
toc:
|
||||
- file: index.md
|
||||
- file: known-issues.md
|
||||
- file: breaking-changes.md
|
||||
- file: deprecations.md
|
||||
Reference in New Issue
Block a user