From 86a573691ac86c445b3094157c0ad34cb29d227d Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Thu, 5 Dec 2024 10:11:15 -0600 Subject: [PATCH] Update links to reference docs from other files --- docs/changelog.asciidoc | 5 ++--- docs/examples/bulk.asciidoc | 4 ++-- docs/examples/scroll.asciidoc | 24 ++++++++++++------------ docs/helpers.asciidoc | 1 + docs/observability.asciidoc | 1 + 5 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/changelog.asciidoc b/docs/changelog.asciidoc index 02745171c..9f9de0e29 100644 --- a/docs/changelog.asciidoc +++ b/docs/changelog.asciidoc @@ -118,8 +118,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15. ===== OpenTelemetry zero-code instrumentation support For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes. -See {jsclient}/observability.html#_opentelemetry[the docs] -for more information. +See <> for more information. [discrete] === 8.14.1 @@ -329,7 +328,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0. [discrete] ===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732] -In the {jsclient}/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to {jsclient}/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it. +In the <>, documents could not be modified before being sent to Elasticsearch. It is now possible to <> before sending it. [discrete] ==== Fixes diff --git a/docs/examples/bulk.asciidoc b/docs/examples/bulk.asciidoc index 74725c9e9..90f5de27a 100644 --- a/docs/examples/bulk.asciidoc +++ b/docs/examples/bulk.asciidoc @@ -1,10 +1,10 @@ [[bulk_examples]] === Bulk -With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a +With the <>, you can perform multiple index/delete operations in a single API call. The `bulk` API significantly increases indexing speed. -NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper]. +NOTE: You can also use the <>. [source,js] ---- diff --git a/docs/examples/scroll.asciidoc b/docs/examples/scroll.asciidoc index 0f23a1bc1..87f302876 100644 --- a/docs/examples/scroll.asciidoc +++ b/docs/examples/scroll.asciidoc @@ -1,25 +1,25 @@ [[scroll_examples]] === Scroll -While a search request returns a single “page” of results, the scroll API can be -used to retrieve large numbers of results (or even all results) from a single -search request, in much the same way as you would use a cursor on a traditional +While a search request returns a single “page” of results, the scroll API can be +used to retrieve large numbers of results (or even all results) from a single +search request, in much the same way as you would use a cursor on a traditional database. -Scrolling is not intended for real time user requests, but rather for processing -large amounts of data, for example in order to reindex the contents of one index +Scrolling is not intended for real time user requests, but rather for processing +large amounts of data, for example in order to reindex the contents of one index into a new index with a different configuration. -NOTE: The results that are returned from a scroll request reflect the state of -the index at the time that the initial search request was made, like a snapshot -in time. Subsequent changes to documents (index, update or delete) will only +NOTE: The results that are returned from a scroll request reflect the state of +the index at the time that the initial search request was made, like a snapshot +in time. Subsequent changes to documents (index, update or delete) will only affect later search requests. -In order to use scrolling, the initial search request should specify the scroll -parameter in the query string, which tells {es} how long it should keep the +In order to use scrolling, the initial search request should specify the scroll +parameter in the query string, which tells {es} how long it should keep the “search context” alive. -NOTE: Did you know that we provide an helper for sending scroll requests? You can find it {jsclient}/client-helpers.html[here]. +NOTE: Did you know that we provide an helper for sending scroll requests? You can find it <>. [source,js] ---- @@ -113,7 +113,7 @@ async function run () { run().catch(console.log) ---- -Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using +Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using async iteration! [source,js] diff --git a/docs/helpers.asciidoc b/docs/helpers.asciidoc index cb60dbc51..021000417 100644 --- a/docs/helpers.asciidoc +++ b/docs/helpers.asciidoc @@ -338,6 +338,7 @@ console.log(result) ---- [discrete] +[[bulk-modify-doc]] ==== Modifying a document before operation ~Added~ ~in~ ~`v8.8.2`~ diff --git a/docs/observability.asciidoc b/docs/observability.asciidoc index 9436d457f..f75b8d87c 100644 --- a/docs/observability.asciidoc +++ b/docs/observability.asciidoc @@ -16,6 +16,7 @@ features. All of these observability features are documented below. [discrete] +[[o11y-otel]] ==== OpenTelemetry The client supports OpenTelemetry's https://opentelemetry.io/docs/zero-code/js/[zero-code