Skip to content

Commit 00d4310

Browse files
committed
Docs: Pin two IDs in the rest client (#40785)
We generate two pages with "funny" names: * _changing_the_client_8217_s_initialization_code.html * _changing_the_application_8217_s_code.html The leading `_` comes from us not specifying the name of the page. The `8217` comes about because of the single quote character. This is a funny name, but it is the name that we have so we shouldn't change it without putting in a redirect. We're looking at switching these docs from being built with the no-longer-maintained AsciiDoc project to being built with the actively-maintained Asciidoctor project. Asciidoctor Doesn't include the `8217`s in the generated ids. That is *better*, but we don't really want to change the pages. Ultimately we'd prefer none of our pages start with `_`, but that is a problem for a different time. Anyway, this pins the ids to their "funny" id so it won't change when we switch to Asciidoctor. We'll remove it later, when we have more fine control of our redirects.
1 parent e62a534 commit 00d4310

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/java-rest/high-level/migration.asciidoc

+4
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ The <<java-rest-high-getting-started,Getting Started>> page shows
4545
<<java-rest-high-getting-started-dependencies, dependencies>> brought by the
4646
high-level client.
4747

48+
// This ID is bad but it is the one we've had forever.
49+
[[_changing_the_client_8217_s_initialization_code]]
4850
=== Changing the client's initialization code
4951

5052
The `TransportClient` is typically initialized as follows:
@@ -94,6 +96,8 @@ must be replaced with:
9496
include-tagged::{doc-tests}/MainDocumentationIT.java[rest-high-level-client-close]
9597
--------------------------------------------------
9698

99+
// This ID is bad but it is the one we've had forever.
100+
[[_changing_the_application_8217_s_code]]
97101
=== Changing the application's code
98102

99103
The `RestHighLevelClient` supports the same request and response objects

0 commit comments

Comments
 (0)