Skip to content

Commit 86a5736

Browse files
committed
Update links to reference docs from other files
1 parent 6c3e2b5 commit 86a5736

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed

docs/changelog.asciidoc

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15.
118118
===== OpenTelemetry zero-code instrumentation support
119119

120120
For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes.
121-
See {jsclient}/observability.html#_opentelemetry[the docs]
122-
for more information.
121+
See <<o11y-otel,the docs>> for more information.
123122

124123
[discrete]
125124
=== 8.14.1
@@ -329,7 +328,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.
329328
[discrete]
330329
===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732]
331330

332-
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.
331+
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.
333332

334333
[discrete]
335334
==== Fixes

docs/examples/bulk.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
[[bulk_examples]]
22
=== Bulk
33

4-
With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a
4+
With the <<client.bulk,`bulk` API>>, you can perform multiple index/delete operations in a
55
single API call. The `bulk` API significantly increases indexing speed.
66

7-
NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper].
7+
NOTE: You can also use the <<bulk-helper,bulk helper>>.
88

99
[source,js]
1010
----

docs/examples/scroll.asciidoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
[[scroll_examples]]
22
=== Scroll
33

4-
While a search request returns a single “page” of results, the scroll API can be
5-
used to retrieve large numbers of results (or even all results) from a single
6-
search request, in much the same way as you would use a cursor on a traditional
4+
While a search request returns a single “page” of results, the scroll API can be
5+
used to retrieve large numbers of results (or even all results) from a single
6+
search request, in much the same way as you would use a cursor on a traditional
77
database.
88

9-
Scrolling is not intended for real time user requests, but rather for processing
10-
large amounts of data, for example in order to reindex the contents of one index
9+
Scrolling is not intended for real time user requests, but rather for processing
10+
large amounts of data, for example in order to reindex the contents of one index
1111
into a new index with a different configuration.
1212

13-
NOTE: The results that are returned from a scroll request reflect the state of
14-
the index at the time that the initial search request was made, like a snapshot
15-
in time. Subsequent changes to documents (index, update or delete) will only
13+
NOTE: The results that are returned from a scroll request reflect the state of
14+
the index at the time that the initial search request was made, like a snapshot
15+
in time. Subsequent changes to documents (index, update or delete) will only
1616
affect later search requests.
1717

18-
In order to use scrolling, the initial search request should specify the scroll
19-
parameter in the query string, which tells {es} how long it should keep the
18+
In order to use scrolling, the initial search request should specify the scroll
19+
parameter in the query string, which tells {es} how long it should keep the
2020
“search context” alive.
2121

22-
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it {jsclient}/client-helpers.html[here].
22+
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it <<scroll-search-helper,here>>.
2323

2424
[source,js]
2525
----
@@ -113,7 +113,7 @@ async function run () {
113113
run().catch(console.log)
114114
----
115115

116-
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
116+
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
117117
async iteration!
118118

119119
[source,js]

docs/helpers.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,6 +338,7 @@ console.log(result)
338338
----
339339

340340
[discrete]
341+
[[bulk-modify-doc]]
341342
==== Modifying a document before operation
342343

343344
~Added~ ~in~ ~`v8.8.2`~

docs/observability.asciidoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ features.
1616
All of these observability features are documented below.
1717

1818
[discrete]
19+
[[o11y-otel]]
1920
==== OpenTelemetry
2021

2122
The client supports OpenTelemetry's https://opentelemetry.io/docs/zero-code/js/[zero-code

0 commit comments

Comments
 (0)