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

Add release notes 2.18 #8663

Merged
merged 1 commit into from
Nov 5, 2024
Merged
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
39 changes: 39 additions & 0 deletions release-notes/opensearch-documentation-release-notes-2.18.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# OpenSearch Documentation Website 2.18.0 Release Notes

Check failure on line 1 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L1

[OpenSearch.HeadingCapitalization] 'OpenSearch Documentation Website 2.18.0 Release Notes' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'OpenSearch Documentation Website 2.18.0 Release Notes' is a heading and should be in sentence case.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 1, "column": 3}}}, "severity": "ERROR"}

The OpenSearch 2.18.0 documentation includes the following additions and updates.

## New documentation for 2.18.0

- Update SQL/PPL multiple value field limitation [#8646](https://github.com/opensearch-project/documentation-website/pull/8646)
- Add new use cases to ML Inference Search Response Processor [#8639](https://github.com/opensearch-project/documentation-website/pull/8639)
- Documentation for query field name and datatype in query shape [#8631](https://github.com/opensearch-project/documentation-website/pull/8631)
- add document for Query Insights health_stats API [#8627](https://github.com/opensearch-project/documentation-website/pull/8627)
- Add new indexing parameter and update performance tuning instruction [#8623](https://github.com/opensearch-project/documentation-website/pull/8623)
- Update default engine from nmslib to faiss [#8620](https://github.com/opensearch-project/documentation-website/pull/8620)

Check failure on line 12 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L12

[OpenSearch.Spelling] Error: nmslib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: nmslib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 12, "column": 30}}}, "severity": "ERROR"}

Check failure on line 12 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L12

[OpenSearch.Spelling] Error: faiss. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: faiss. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 12, "column": 40}}}, "severity": "ERROR"}

Check failure on line 12 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L12

[Vale.Terms] Use 'Faiss' instead of 'faiss'.
Raw output
{"message": "[Vale.Terms] Use 'Faiss' instead of 'faiss'.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 12, "column": 40}}}, "severity": "ERROR"}
- Update documentation for coordination settings and batch size [#8604](https://github.com/opensearch-project/documentation-website/pull/8604)
- Update JDK version for 2.x distributions [#8603](https://github.com/opensearch-project/documentation-website/pull/8603)
- Add documentation for star tree index feature [#8598](https://github.com/opensearch-project/documentation-website/pull/8598)
- Add URI paths for cluster stats filtering. [#8595](https://github.com/opensearch-project/documentation-website/pull/8595)
- Adding documentation for _list APIs [#8594](https://github.com/opensearch-project/documentation-website/pull/8594)

Check failure on line 17 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L17

[OpenSearch.Spelling] Error: _list. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: _list. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 17, "column": 29}}}, "severity": "ERROR"}
- Adds documentation about byField rerank processor [#8593](https://github.com/opensearch-project/documentation-website/pull/8593)

Check failure on line 18 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L18

[OpenSearch.Spelling] Error: byField. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: byField. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 18, "column": 28}}}, "severity": "ERROR"}
- Updating tiered caching settings [#8592](https://github.com/opensearch-project/documentation-website/pull/8592)
- Add documentation changes for cluster level dynamic limit settings to block cat/indices, _cat/shards and _cat/segments [#8590](https://github.com/opensearch-project/documentation-website/pull/8590)

Check failure on line 20 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L20

[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.
Raw output
{"message": "[OpenSearch.SubstitutionsError] Use 'indexes' instead of 'indices'.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 20, "column": 83}}}, "severity": "ERROR"}
- Add doc for dynamic threadpool settings [#8588](https://github.com/opensearch-project/documentation-website/pull/8588)

Check failure on line 21 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L21

[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: threadpool. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 21, "column": 23}}}, "severity": "ERROR"}
- Add value range for the search backpressure settings [#8555](https://github.com/opensearch-project/documentation-website/pull/8555)
- Add new rename_alias parameters for restore-snapshot [#8544](https://github.com/opensearch-project/documentation-website/pull/8544)
- Add SQL PIT reference [#8541](https://github.com/opensearch-project/documentation-website/pull/8541)
- Document cluster.default_number_of_replicas and update index.number_of_replicas [#8526](https://github.com/opensearch-project/documentation-website/pull/8526)
- Msearch template API returns status code in each search response [#8522](https://github.com/opensearch-project/documentation-website/pull/8522)

Check failure on line 26 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L26

[OpenSearch.Spelling] Error: Msearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: Msearch. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 26, "column": 3}}}, "severity": "ERROR"}
- document the new `analysis-phonenumber` plugin [#8469](https://github.com/opensearch-project/documentation-website/pull/8469)
- Adds documentation for providing search pipeline id in the search/msearch request [#8372](https://github.com/opensearch-project/documentation-website/pull/8372)
- Data Stream support for Audit- Log [#8356](https://github.com/opensearch-project/documentation-website/pull/8356)
- Update documentation to reflect k-NN FAISS AVX512 support [#8307](https://github.com/opensearch-project/documentation-website/pull/8307)

Check failure on line 30 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L30

[Vale.Terms] Use 'Faiss' instead of 'FAISS'.
Raw output
{"message": "[Vale.Terms] Use 'Faiss' instead of 'FAISS'.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 30, "column": 40}}}, "severity": "ERROR"}
- [Feature]: add ignore missing to text chunking processor [#8266](https://github.com/opensearch-project/documentation-website/pull/8266)
- Add documentation for workload management [#8228](https://github.com/opensearch-project/documentation-website/pull/8228)

## In progress documentation for 2.18.0

- [Workspace] Add documentation for workspace and ACL [#8643](https://github.com/opensearch-project/documentation-website/pull/8643)
- add wlm feature overview [#8632](https://github.com/opensearch-project/documentation-website/pull/8632)

Check failure on line 37 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L37

[OpenSearch.Spelling] Error: wlm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: wlm. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 37, "column": 7}}}, "severity": "ERROR"}
- Add querygroup lifecycle api documentation [#8628](https://github.com/opensearch-project/documentation-website/pull/8628)

Check failure on line 38 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L38

[OpenSearch.Spelling] Error: querygroup. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: querygroup. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 38, "column": 7}}}, "severity": "ERROR"}

Check failure on line 38 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L38

[OpenSearch.Spelling] Error: api. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: api. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 38, "column": 28}}}, "severity": "ERROR"}
- [Workload Management] Querygroup Lifecyle API docs [#8249](https://github.com/opensearch-project/documentation-website/pull/8249)

Check failure on line 39 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L39

[OpenSearch.Spelling] Error: Querygroup. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: Querygroup. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 39, "column": 25}}}, "severity": "ERROR"}

Check failure on line 39 in release-notes/opensearch-documentation-release-notes-2.18.0.md

View workflow job for this annotation

GitHub Actions / vale

[vale] release-notes/opensearch-documentation-release-notes-2.18.0.md#L39

[OpenSearch.Spelling] Error: Lifecyle. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.
Raw output
{"message": "[OpenSearch.Spelling] Error: Lifecyle. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "release-notes/opensearch-documentation-release-notes-2.18.0.md", "range": {"start": {"line": 39, "column": 36}}}, "severity": "ERROR"}
Loading