qa elasticsearch

Author: colleenmcginnis

serverless/pages/elasticsearch/apis-elasticsearch-conventions.asciidoc

@@ -14,7 +14,7 @@ For example:
 GET _cat/indices?v=true
 ----
 
-Check out https://www.elastic.co/docs/current/serverless/devtools/run-api-requests-in-the-console[].
+Check out <<devtools-run-api-requests-in-the-console>>.
 
 [discrete]
 [[elasticsearch-api-conventions-request-headers]]

serverless/pages/elasticsearch/apis-http-apis.asciidoc

@@ -6,6 +6,6 @@
 
 preview:[]
 
-* <<elasticsearch-api-conventions>>
-* <<elasticsearch-kibana-api-conventions>>
+* <<elasticsearch-api-conventions>>: The {es} REST APIs have conventions for headers and request bodies.
+* <<elasticsearch-kibana-api-conventions>>: The Management APIs for {serverless-short} have request header conventions.
 * https://www.elastic.co/docs/api/[API Reference]: Explore the reference information for Elastic Serverless REST APIs

serverless/pages/elasticsearch/apis-kibana-conventions.asciidoc

@@ -29,7 +29,7 @@ For example:
 GET kbn:/api/data_views
 ----
 
-Check out https://www.elastic.co/docs/current/serverless/devtools/run-api-requests-in-the-console[].
+Check out <<devtools-run-api-requests-in-the-console>>.
 
 [discrete]
 [[elasticsearch-kibana-api-conventions-request-headers]]
@@ -42,7 +42,7 @@ The Management APIs support the `Authorization`, `Content-Type`, and  `kbn-xsrf`
 
 Management APIs use key-based authentication.
 You must create an API key and use the encoded value in the request header.
-To learn about creating keys, go to https://www.elastic.co/docs/current/serverless/api-keys[].
+To learn about creating keys, go to <<api-keys>>.
 
 `Content-Type: application/json`::
 

serverless/pages/elasticsearch/clients-go-getting-started.asciidoc

@@ -41,15 +41,15 @@ The following snippets use these imports:
 [source,go]
 ----
 import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"log"
-	"strconv"
-
-	"github.com/elastic/elasticsearch-serverless-go"
-	"github.com/elastic/elasticsearch-serverless-go/typedapi/types"
-	"github.com/elastic/elasticsearch-serverless-go/typedapi/types/enums/result"
+  "context"
+  "encoding/json"
+  "fmt"
+  "log"
+  "strconv"
+
+  "github.com/elastic/elasticsearch-serverless-go"
+  "github.com/elastic/elasticsearch-serverless-go/typedapi/types"
+  "github.com/elastic/elasticsearch-serverless-go/typedapi/types/enums/result"
 )
 ----
 
@@ -62,8 +62,8 @@ Initialize the client using your API key and Elasticsearch Endpoint:
 [source,go]
 ----
 client, err := elasticsearch.NewClient(elasticsearch.Config{
-	APIKey: "you_api_key",
-	Address: "https://my-project-url",
+  APIKey: "you_api_key",
+  Address: "https://my-project-url",
 })
 if err != nil {
     log.Fatal(err)

serverless/pages/elasticsearch/clients-go-getting-started.mdx

@@ -35,15 +35,15 @@ The following snippets use these imports:
 
 ```go
 import (
-	"context"
-	"encoding/json"
-	"fmt"
-	"log"
-	"strconv"
-
-	"github.com/elastic/elasticsearch-serverless-go"
-	"github.com/elastic/elasticsearch-serverless-go/typedapi/types"
-	"github.com/elastic/elasticsearch-serverless-go/typedapi/types/enums/result"
+  "context"
+  "encoding/json"
+  "fmt"
+  "log"
+  "strconv"
+
+  "github.com/elastic/elasticsearch-serverless-go"
+  "github.com/elastic/elasticsearch-serverless-go/typedapi/types"
+  "github.com/elastic/elasticsearch-serverless-go/typedapi/types/enums/result"
 )
 ```
 
@@ -54,8 +54,8 @@ Initialize the client using your API key and Elasticsearch Endpoint:
 
 ```go
 client, err := elasticsearch.NewClient(elasticsearch.Config{
-	APIKey: "you_api_key",
-	Address: "https://my-project-url",
+  APIKey: "you_api_key",
+  Address: "https://my-project-url",
 })
 if err != nil {
     log.Fatal(err)

serverless/pages/elasticsearch/clients-ruby-getting-started.asciidoc

@@ -16,7 +16,6 @@ client for {es3}, shows you how to initialize the client, and how to perform bas
 
 * Ruby 3.0 or higher installed on your system.
 * To use the `elasticsearch-serverless` gem, you must have an API key and Elasticsearch Endpoint for an {es3} project.
-*
 
 [discrete]
 [[elasticsearch-ruby-client-getting-started-installation]]
@@ -126,7 +125,7 @@ index:
 [source,ruby]
 ----
 # First, build your data:
-\> body = [
+> body = [
   { index: { _index: 'books', data: {name: "Snow Crash", author: "Neal Stephenson", release_date: "1992-06-01", page_count: 470} } },
   { index: { _index: 'books', data: {name: "Revelation Space", author: "Alastair Reynolds", release_date: "2000-03-15", page_count: 585} } },
   { index: { _index: 'books', data: {name: "1984", author: "George Orwell", release_date: "1949-06-08", page_count: 328} } },
@@ -135,9 +134,9 @@ index:
   { index: { _index: 'books', data: {name: "The Handmaid's Tale", author: "Margaret Atwood", release_date: "1985-06-01", page_count: 311} } }
 ]
 # Then ingest the data via the bulk API:
-\> response = client.bulk(body: body)
+> response = client.bulk(body: body)
 # You can check the response if the items are indexed and have a document (doc) ID:
-\> response['items']
+> response['items']
 # Returns:
 #  =>
 # [{"index"=>{"_index"=>"books", "_id"=>"Pdink4cBmDx329iqhzM2", "_version"=>1, "result"=>"created", "_shards"=>{"total"=>2, "successful"=>1, "failed"=>0}, "_seq_no"=>0, "_primary_term"=>1, "status"=>201}},
@@ -162,7 +161,7 @@ You can get documents by using the following code:
 
 [source,ruby]
 ----
-\> client.get(index: 'books', id: 'id') # Replace 'id' with a valid doc ID
+> client.get(index: 'books', id: 'id') # Replace 'id' with a valid doc ID
 ----
 
 [discrete]
@@ -174,8 +173,8 @@ Now that some data is available, you can search your documents using the
 
 [source,ruby]
 ----
-\> response = client.search(index: 'books', q: 'snow')
-\> response['hits']['hits']
+> response = client.search(index: 'books', q: 'snow')
+> response['hits']['hits']
 # Returns:
 # => [{"_index"=>"books", "_id"=>"Pdink4cBmDx329iqhzM2", "_score"=>1.5904956, "_source"=>{"name"=>"Snow Crash", "author"=>"Neal Stephenson", "release_date"=>"1992-06-01", "page_count"=>470}}]
 ----
@@ -188,7 +187,7 @@ You can call the `update` API to update a document:
 
 [source,ruby]
 ----
-\> response = client.update(
+> response = client.update(
   index: 'books',
   id: 'id',  # Replace 'id' with a valid doc ID
   body: { doc: { page_count: 312 } }
@@ -203,7 +202,7 @@ You can call the `delete` API to delete a document:
 
 [source,ruby]
 ----
-\> client.delete(index: 'books', id: 'id')  # Replace 'id' with a valid doc ID
+> client.delete(index: 'books', id: 'id')  # Replace 'id' with a valid doc ID
 ----
 
 [discrete]
@@ -212,5 +211,5 @@ You can call the `delete` API to delete a document:
 
 [source,ruby]
 ----
-\> client.indices.delete(index: 'books')
+> client.indices.delete(index: 'books')
 ----

serverless/pages/elasticsearch/clients-ruby-getting-started.mdx

@@ -15,7 +15,6 @@ client for ((es3)), shows you how to initialize the client, and how to perform b
 
 * Ruby 3.0 or higher installed on your system.
 * To use the `elasticsearch-serverless` gem, you must have an API key and Elasticsearch Endpoint for an ((es3)) project.
-*
 
 ## Installation
 

serverless/pages/elasticsearch/elasticsearch-developer-tools.asciidoc

@@ -6,15 +6,11 @@
 
 preview:[]
 
-[discrete]
-[[elasticsearch-dev-tools-developer-tools]]
-== Developer tools
-
 A number of developer tools are available in your project's UI under the **Dev Tools** section.
 
-* https://www.elastic.co/docs/current/serverless/devtools/run-api-requests-in-the-console[Console]: Make API calls to your Elasticsearch instance using the Query DSL and view the responses.
-* https://www.elastic.co/docs/current/serverless/devtools/profile-queries-and-aggregations[Search Profiler]: Inspect and analyze your search queries to identify performance bottlenecks.
-* https://www.elastic.co/docs/current/serverless/devtools/debug-grok-expressions[Grok Debugger]: Build and debug grok patterns before you use them in your data processing pipelines.
+* <<devtools-run-api-requests-in-the-console,Console>>: Make API calls to your Elasticsearch instance using the Query DSL and view the responses.
+* <<devtools-profile-queries-and-aggregations,Search Profiler>>: Inspect and analyze your search queries to identify performance bottlenecks.
+* <<devtools-debug-grok-expressions,Grok Debugger>>: Build and debug grok patterns before you use them in your data processing pipelines.
 
 // ## Troubleshooting
 

serverless/pages/elasticsearch/elasticsearch-developer-tools.mdx

@@ -6,7 +6,6 @@ tags: [ 'serverless', 'elasticsearch', 'overview' ]
 ---
 
 <DocBadge template="technical preview" />
-## Developer tools
 
 A number of developer tools are available in your project's UI under the **Dev Tools** section.
 

serverless/pages/elasticsearch/explore-your-data-alerting.asciidoc

@@ -20,7 +20,7 @@ In **{alerts-app}** or **{project-settings} → {manage-app} → {rules-app}** y
 [role="screenshot"]
 image::images/rules-ui.png[Example rule listing in {rules-ui}]
 
-For an overview of alerting concepts, go to https://www.elastic.co/docs/current/serverless/rules[].
+For an overview of alerting concepts, go to <<rules>>.
 
 ////
 /* ## Required permissions
@@ -80,7 +80,7 @@ When a rule is in a snoozed state, you can cancel or change the duration of this
 [[elasticsearch-explore-your-data-alerting-import-and-export-rules]]
 == Import and export rules
 
-To import and export rules, use https://www.elastic.co/docs/current/serverless/saved-objects[saved objects].
+To import and export rules, use <<saved-objects,saved objects>>.
 
 ////
 /*