Skip to content

Commit

Permalink
Update links to reference docs from other files
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshMock committed Dec 5, 2024
1 parent a7d9d41 commit bcb5cfb
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 17 deletions.
5 changes: 2 additions & 3 deletions docs/changelog.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,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 <<o11y-otel,the docs>> for more information.

[discrete]
=== 8.14.1
Expand Down Expand Up @@ -286,7 +285,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 <<bulk-helper,bulk helper>>, documents could not be modified before being sent to Elasticsearch. It is now possible to <<bulk-modify-doc,modify a document>> before sending it.

[discrete]
==== Fixes
Expand Down
4 changes: 2 additions & 2 deletions docs/examples/bulk.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<client.bulk,`bulk` API>>, 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 <<bulk-helper,bulk helper>>.

[source,js]
----
Expand Down
24 changes: 12 additions & 12 deletions docs/examples/scroll.asciidoc
Original file line number Diff line number Diff line change
@@ -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 <<scroll-search-helper,here>>.

[source,js]
----
Expand Down Expand Up @@ -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]
Expand Down
1 change: 1 addition & 0 deletions docs/helpers.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,7 @@ console.log(result)
----

[discrete]
[[bulk-modify-doc]]
==== Modifying a document before operation

~Added~ ~in~ ~`v8.8.2`~
Expand Down
1 change: 1 addition & 0 deletions docs/observability.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit bcb5cfb

Please sign in to comment.