From 5d8ca116d1ae6294fe7684a080d51c0c879c0fc4 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Wed, 3 Apr 2019 10:09:01 -0400 Subject: [PATCH] Docs: Pin two IDs in the rest client 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. --- docs/java-rest/high-level/migration.asciidoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/java-rest/high-level/migration.asciidoc b/docs/java-rest/high-level/migration.asciidoc index a42a9352faace..c8db57f52598d 100644 --- a/docs/java-rest/high-level/migration.asciidoc +++ b/docs/java-rest/high-level/migration.asciidoc @@ -45,6 +45,8 @@ The <> page shows <> brought by the high-level client. +// This ID is bad but it is the one we've had forever. +[[_changing_the_client_8217_s_initialization_code]] === Changing the client's initialization code The `TransportClient` is typically initialized as follows: @@ -94,6 +96,8 @@ must be replaced with: include-tagged::{doc-tests}/MiscellaneousDocumentationIT.java[rest-high-level-client-close] -------------------------------------------------- +// This ID is bad but it is the one we've had forever. +[[_changing_the_application_8217_s_code]] === Changing the application's code The `RestHighLevelClient` supports the same request and response objects