Skip to content

Commit 0aa8461

Browse files
fix mdx syntax and links
1 parent e29798c commit 0aa8461

10 files changed

+57
-61
lines changed

serverless/pages/action-connectors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The list of available connectors varies by project type.
4646
{
4747
"title": "Google Gemini",
4848
"description": "Send a request to Google Gemini.",
49-
"href": "https://www.elastic.co/guide/en/kibana/master/gemini-action-type.html",
49+
"href": "((kibana-ref))/gemini-action-type.html",
5050
"target": "_blank"
5151
},
5252
{

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ client for ((es3)), shows you how to initialize the client, and how to perform b
1515

1616
* Ruby 3.0 or higher installed on your system.
1717
* To use the `elasticsearch-serverless` gem, you must have an API key and Elasticsearch Endpoint for an ((es3)) project.
18-
*
1918

2019
## Installation
2120

serverless/pages/elasticsearch-developer-tools.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ tags: [ 'serverless', 'elasticsearch', 'overview' ]
66
---
77

88
<DocBadge template="technical preview" />
9-
## Developer tools
109

1110
A number of developer tools are available in your project's UI under the **Dev Tools** section.
1211

serverless/pages/explore-your-data-discover-your-data.mdx

Lines changed: 45 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -32,34 +32,31 @@ Tell ((kib)) where to find the data you want to explore, and then specify the ti
3232

3333
1. Once the book sample data has been ingested, navigate to **Explore → Discover** and click **Create data view**.
3434

35-
2. Give your data view a name.
35+
1. Give your data view a name.
3636

37-
<DocImage size="xxl" url="../images/create-data-view.png" alt="Create a data view" />
37+
<DocImage size="xxl" url="../images/create-data-view.png" alt="Create a data view" />
3838

39-
3. Start typing in the **Index pattern** field, and the names of indices, data streams, and aliases that match your input will be displayed.
39+
1. Start typing in the **Index pattern** field, and the names of indices, data streams, and aliases that match your input will be displayed.
4040

41-
- To match multiple sources, use a wildcard (*), for example, `b*` and any indices starting with the letter `b` display.
41+
- To match multiple sources, use a wildcard (*), for example, `b*` and any indices starting with the letter `b` display.
42+
- To match multiple sources, enter their names separated by a comma. Do not include a space after the comma. For example `books,magazines` would match two indices: `books` and `magazines`.
43+
- To exclude a source, use a minus sign (-), for example `-books`.
4244

43-
- To match multiple sources, enter their names separated by a comma. Do not include a space after the comma. For example `books,magazines` would match two indices: `books` and `magazines`.
45+
1. In the **Timestamp** field dropdown, and then select `release_date`.
4446

45-
- To exclude a source, use a minus sign (-), for example `-books`.
47+
- If you don't set a time field, you can't use global time filters on your dashboards. Leaving the time field unset might be useful if you have multiple time fields and want to create dashboards that combine visualizations based on different timestamps.
48+
- If your index doesn't have time-based data, choose **I don't want to use the time filter**.
4649

47-
4. In the **Timestamp** field dropdown, and then select `release_date`.
50+
1. Click **Show advanced settings** to:
4851

49-
- If you don't set a time field, you can't use global time filters on your dashboards. Leaving the time field unset might be useful if you have multiple time fields and want to create dashboards that combine visualizations based on different timestamps.
52+
- Display hidden and system indices.
53+
- Specify your own data view name. For example, enter your Elasticsearch index alias name.
5054

51-
- If your index doesn't have time-based data, choose **I don't want to use the time filter**.
55+
1. Click **Save data view to ((kib))**.
5256

53-
5. Click **Show advanced settings** to:
57+
1. Adjust the time range to view data for the **Last 40 years** to view all your book data.
5458

55-
- Display hidden and system indices.
56-
- Specify your own data view name. For example, enter your Elasticsearch index alias name.
57-
58-
6. Click **Save data view to ((kib))**.
59-
60-
7. Adjust the time range to view data for the **Last 40 years** to view all your book data.
61-
62-
<DocImage size="xxl" url="../images/book-data.png" alt="Your book data displayed" />
59+
<DocImage size="xxl" url="../images/book-data.png" alt="Your book data displayed" />
6360

6461
<div id="explore-fields-in-your-data"></div>
6562

@@ -69,11 +66,11 @@ Tell ((kib)) where to find the data you want to explore, and then specify the ti
6966

7067
1. In the sidebar, enter `au` in the search field to find the `author` field.
7168

72-
2. In the **Available fields** list, click `author` to view its most popular values.
69+
1. In the **Available fields** list, click `author` to view its most popular values.
7370

74-
**Discover** shows the top 10 values and the number of records used to calculate those values.
71+
**Discover** shows the top 10 values and the number of records used to calculate those values.
7572

76-
3. Click <DocIcon type="plusInCircleFilled" title="Add" /> to toggle the field into the document table. You can also drag the field from the **Available fields** list into the document table.
73+
1. Click <DocIcon type="plusInCircleFilled" title="Add" /> to toggle the field into the document table. You can also drag the field from the **Available fields** list into the document table.
7774

7875
## Add a field to your ((data-source))
7976

@@ -85,29 +82,29 @@ the same way you do with other fields.
8582

8683
1. In the sidebar, click **Add a field**.
8784

88-
2. In the **Create field** form, enter `hello` for the name.
85+
1. In the **Create field** form, enter `hello` for the name.
8986

90-
3. Turn on **Set value**.
87+
1. Turn on **Set value**.
9188

92-
4. Define the script using the Painless scripting language. Runtime fields require an `emit()`.
89+
1. Define the script using the Painless scripting language. Runtime fields require an `emit()`.
9390

9491
```ts
9592
emit("Hello World!");
9693
```
9794

98-
5. Click **Save**.
95+
1. Click **Save**.
9996

100-
6. In the sidebar, search for the **hello** field, and then add it to the document table.
97+
1. In the sidebar, search for the **hello** field, and then add it to the document table.
10198

102-
7. Create a second field named `authorabbrev` that combines the authors last name and first initial.
99+
1. Create a second field named `authorabbrev` that combines the authors last name and first initial.
103100

104101
```ts
105102
String str = doc['author.keyword'].value;
106103
char ch1 = str.charAt(0);
107104
emit(doc['author.keyword'].value + ", " + ch1);
108105
```
109106

110-
8. Add `authorabbrev` to the document table.
107+
1. Add `authorabbrev` to the document table.
111108

112109
<DocImage size="xxl" url="../images/add-fields.png" alt="How the fields you just created should display" />
113110

@@ -122,7 +119,7 @@ To search particular fields and build more complex queries, use the ((kib)) Quer
122119
Search the book data to find out which books have more than 500 pages:
123120

124121
1. Enter `p`, and then select **page_count**.
125-
2. Select **>** for greater than and enter **500**, then click the refresh button or press the Enter key to see which books have more than 500 pages.
122+
1. Select **>** for greater than and enter **500**, then click the refresh button or press the Enter key to see which books have more than 500 pages.
126123

127124
<div id="filter-in-discover"></div>
128125

@@ -136,10 +133,10 @@ and more.
136133
Exclude documents where the author is not Terry Pratchett:
137134

138135
1. Click <DocIcon type="plusInCircleFilled" title="Add" /> next to the query bar.
139-
2. In the **Add filter** pop-up, set the field to **author**, the operator to **is not**, and the value to **Terry Pratchett**.
140-
3. Click **Add filter**.
141-
4. Continue your exploration by adding more filters.
142-
5. To remove a filter, click the close icon (x) next to its name in the filter bar.
136+
1. In the **Add filter** pop-up, set the field to **author**, the operator to **is not**, and the value to **Terry Pratchett**.
137+
1. Click **Add filter**.
138+
1. Continue your exploration by adding more filters.
139+
1. To remove a filter, click the close icon (x) next to its name in the filter bar.
143140

144141
<div id="look-inside-a-document"></div>
145142

@@ -149,11 +146,11 @@ Dive into an individual document to view its fields and the documents that occur
149146

150147
1. In the document table, click the expand icon <DocIcon type="expand" title="View details" /> to show document details.
151148

152-
2. Scan through the fields and their values. If you find a field of interest, hover your mouse over the **Actions** column for filters and other options.
149+
1. Scan through the fields and their values. If you find a field of interest, hover your mouse over the **Actions** column for filters and other options.
153150

154-
3. To create a view of the document that you can bookmark and share, click **Single document**.
151+
1. To create a view of the document that you can bookmark and share, click **Single document**.
155152

156-
4. To view documents that occurred before or after the event you are looking at, click **Surrounding documents**.
153+
1. To view documents that occurred before or after the event you are looking at, click **Surrounding documents**.
157154

158155
<div id="save-your-search"></div>
159156

@@ -163,26 +160,26 @@ Save your search so you can use it later to generate a CSV report, create visual
163160

164161
1. In the upper right toolbar, click **Save**.
165162

166-
2. Give your search a title.
163+
1. Give your search a title.
167164

168-
3. Optionally store tags and the time range with the search.
165+
1. Optionally store tags and the time range with the search.
169166

170-
4. Click **Save**.
167+
1. Click **Save**.
171168

172169
## Visualize your findings
173170
If a field can be [aggregated](((ref))/search-aggregations.html), you can quickly visualize it from **Discover**.
174171

175172
1. In the sidebar, find and then click `release_date`.
176173

177-
2. In the popup, click **Visualize**.
174+
1. In the popup, click **Visualize**.
178175

179-
<DocCallOut title="Note">
180-
((kib)) creates a visualization best suited for this field.
181-
</DocCallOut>
176+
<DocCallOut title="Note">
177+
((kib)) creates a visualization best suited for this field.
178+
</DocCallOut>
182179

183-
3. From the **Available fields** list, drag and drop `page_count` onto the workspace.
180+
1. From the **Available fields** list, drag and drop `page_count` onto the workspace.
184181

185-
4. Save your visualization for use on a dashboard.
182+
1. Save your visualization for use on a dashboard.
186183

187184
For geographical point fields, if you click **Visualize**, your data appears in a map.
188185

@@ -201,12 +198,12 @@ From **Discover**, you can create a rule to periodically check when data goes ab
201198
1. Ensure that your data view,
202199
query, and filters fetch the data for which you want an alert.
203200

204-
2. In the toolbar, click **Alerts → Create search threshold rule**.
201+
1. In the toolbar, click **Alerts → Create search threshold rule**.
205202

206203
The **Create rule** form is pre-filled with the latest query sent to ((es)).
207204

208-
3. Configure your ((es)) query and select a connector type.
205+
1. Configure your ((es)) query and select a connector type.
209206

210-
4. Click **Save**.
207+
1. Click **Save**.
211208

212209
For more about this and other rules provided in ((alert-features)), go to <DocLink slug="/serverless/elasticsearch/explore-your-data-alerting">Alerting</DocLink>.

serverless/pages/explore-your-data-visualize-your-data-create-visualizations.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -391,7 +391,7 @@ To personalize your dashboards, add your own logos and graphics with the **Image
391391

392392
1. To save the new image panel to your dashboard click **Save**.
393393

394-
To manage your uploaded image files, open the main menu, then click ** Management → Files**.
394+
To manage your uploaded image files, open the main menu, then click **Management → Files**.
395395

396396
<DocCallOut title="Warning" color="warning">
397397

serverless/pages/ingest-your-data-ingest-data-through-integrations-connector-client.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22
slug: /serverless/elasticsearch/ingest-data-through-integrations-connector-client
33
title: Connector clients
44
description: Set up and deploy self-managed connectors that run on your own infrastructure.
5-
tags: [ 'serverless', 'elasticsearch', 'ingest', 'connector', how to' ]
5+
tags: [ 'serverless', 'elasticsearch', 'ingest', 'connector', 'how to' ]
66
status: in review
77
---
88

99
<DocCallOut color="warning" title="Note">
10-
This page contains high-level instructions about setting up connector clients in your project's UI.
10+
This page contains high-level instructions about setting up connector clients in your project's UI.
1111
Because prerequisites and configuration details vary by data source, you'll need to refer to the individual connector documentation for specific details.
1212
</DocCallOut>
1313

@@ -94,7 +94,7 @@ You'll need to update these values in your [`config.yml`](https://github.com/ela
9494

9595
## Step 2: Deploy your self-managed connector
9696

97-
To use connector clients, you must deploy the connector service so your connector can talk to your ((es)) instance.
97+
To use connector clients, you must deploy the connector service so your connector can talk to your ((es)) instance.
9898
The source code is hosted in the `elastic/connectors` repository.
9999

100100
You have two deployment options:
@@ -168,7 +168,7 @@ Find all available Docker images in the [official Elastic Docker registry](https
168168

169169
### Run from source
170170

171-
Running from source requires cloning the repository and running the code locally.
171+
Running from source requires cloning the repository and running the code locally.
172172
Use this approach if you're actively customizing connectors.
173173

174174
Follow these steps:

serverless/pages/knn-search.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@ shards.
331331
The score of each hit is the sum of the `knn` and `query` scores. You can specify a `boost` value to give a weight to
332332
each score in the sum. In the example above, the scores will be calculated as
333333

334-
```
334+
```txt
335335
score = 0.9 * match_score + 0.1 * knn_score
336336
```
337337

@@ -446,7 +446,7 @@ all index shards.
446446

447447
The scoring for a doc with the above configured boosts would be:
448448

449-
```
449+
```txt
450450
score = 0.9 * match_score + 0.1 * knn_score_image-vector + 0.5 * knn_score_title-vector
451451
```
452452

serverless/pages/maintenance-windows.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ For example, you can suppress notifications for alerts from specific rules:
4949
<DocCallOut>
5050
- You can select only a single category when you turn on filters.
5151
- Some rules are not affected by maintenance window filters because their alerts do not contain requisite data.
52-
In particular, [((stack-monitor-app))](((kibana-ref))/kibana-alerts.html), [tracking containment](((kibana-ref))geo-alerting.html), [((anomaly-jobs)) health](((ml-docs))/ml-configuring-alerts.html), and [transform health](((ref))/transform-alerts.html) rules are not affected by the filters.
52+
In particular, [((stack-monitor-app))](((kibana-ref))/kibana-alerts.html), [tracking containment](((kibana-ref))/geo-alerting.html), [((anomaly-jobs)) health](((ml-docs))/ml-configuring-alerts.html), and [transform health](((ref))/transform-alerts.html) rules are not affected by the filters.
5353
</DocCallOut>
5454

5555
A maintenance window can have any one of the following statuses:

serverless/pages/search-your-data-semantic-search-elser.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,11 +309,11 @@ search results.
309309

310310
<div id="optimization"></div>
311311

312-
# Optimizing performance
312+
## Optimizing performance
313313

314314
<div id="save-space"></div>
315315

316-
## Saving disk space by excluding the ELSER tokens from document source
316+
### Saving disk space by excluding the ELSER tokens from document source
317317

318318
The tokens generated by ELSER must be indexed for use in the
319319
[sparse_vector query](((ref))/query-dsl-sparse-vector-query.html). However, it is not

serverless/pages/tags.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ To assign and remove tags, you must have `write` permission on the objects to wh
5555
1. Click the actions icon and then select **Manage assignments**.
5656

5757
1. Select the objects to which you want to assign or remove tags.
58+
5859
![Assign tags to saved objects](../images/tag-assignment.png)
5960

6061
1. Click **Save tag assignments**.

0 commit comments

Comments
 (0)