From a1740b6f28940d6f59d7e591fa7f5dfb2808334a Mon Sep 17 00:00:00 2001 From: Sylvain Wallez Date: Fri, 4 Apr 2025 10:47:03 +0200 Subject: [PATCH 1/2] Small doc fixes --- docs/docset.yml | 1 + docs/reference/index.md | 2 +- docs/reference/installation.md | 6 +++--- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/docset.yml b/docs/docset.yml index 86665e9e..e1e5eb8b 100644 --- a/docs/docset.yml +++ b/docs/docset.yml @@ -5,3 +5,4 @@ toc: - toc: reference subs: es: "Elasticsearch" + version: "9.0.0-alpha.1" diff --git a/docs/reference/index.md b/docs/reference/index.md index d074996d..25f531aa 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -31,7 +31,7 @@ The Elasticsearch Rust client is forward compatible; meaning that the client sup ## Create a client [_create_a_client] -To create a client to make API calls to Elasticsearch running on `\https://localhost:9200` +To create a client to make API calls to Elasticsearch running on `https://localhost:9200` ```rust let client = Elasticsearch::default(); diff --git a/docs/reference/installation.md b/docs/reference/installation.md index e75f51ed..8dac12de 100644 --- a/docs/reference/installation.md +++ b/docs/reference/installation.md @@ -9,13 +9,13 @@ Add `elasticsearch` crate and version to Cargo.toml. Choose the version that is ```toml [dependencies] -elasticsearch = "8.7.0-alpha.1" +elasticsearch = "{{version}}" ``` The following *optional* dependencies may also be useful to create requests and read responses: ```toml -serde = "~1" -serde_json = "~1" +serde = "1" +serde_json = "1" ``` From cddd96dc4501d26c2f14e1cf371718162acafd1b Mon Sep 17 00:00:00 2001 From: Sylvain Wallez Date: Fri, 4 Apr 2025 11:12:07 +0200 Subject: [PATCH 2/2] Enable variable substitution --- docs/reference/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/installation.md b/docs/reference/installation.md index 8dac12de..15037ef8 100644 --- a/docs/reference/installation.md +++ b/docs/reference/installation.md @@ -7,7 +7,7 @@ mapped_pages: Add `elasticsearch` crate and version to Cargo.toml. Choose the version that is compatible with the version of {{es}} you are using: -```toml +```toml subs=true [dependencies] elasticsearch = "{{version}}" ```