[DOC] Change navigation for better usability (#5227)
* Change navigation for better usability * Remove duplicate parent page and fix navigation for new pages Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Melissa Vagi <vagimeli@amazon.com> Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Co-authored-by: Fanit Kolchina <kolchfa@amazon.com>
This commit is contained in:
parent
7a5a381e08
commit
27798ba8e5
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: default
|
||||
title: Ingest APIs
|
||||
has_children: true
|
||||
has_children: false
|
||||
nav_order: 40
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/ingest-apis/index/
|
||||
|
|
|
@ -37,6 +37,9 @@ collections:
|
|||
im-plugin:
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
ingest-pipelines:
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
dashboards:
|
||||
permalink: /:collection/:path/
|
||||
output: true
|
||||
|
@ -121,6 +124,9 @@ just_the_docs:
|
|||
im-plugin:
|
||||
name: Managing Indexes
|
||||
nav_fold: true
|
||||
ingest-pipelines:
|
||||
name: Ingest Pipelines
|
||||
nav_fold: true
|
||||
dashboards:
|
||||
name: OpenSearch Dashboards
|
||||
nav_fold: true
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: default
|
||||
title: Custom branding
|
||||
nav_order: 125
|
||||
nav_order: 130
|
||||
---
|
||||
|
||||
# Custom branding
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
---
|
||||
layout: default
|
||||
title: Dashboards Query Language
|
||||
parent: Discover
|
||||
nav_order: 40
|
||||
title: DQL
|
||||
nav_order: 130
|
||||
redirect_from:
|
||||
- /dashboards/dql/
|
||||
- /dashboards/discover/dql/
|
||||
---
|
||||
|
||||
# Dashboards Query Language
|
||||
# DQL
|
||||
|
||||
Dashboards Query Language (DQL) is a simple text-based query language for filtering data in OpenSearch Dashboards. Similar to [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index), DQL uses an HTTP request body. For example, to display your site visitor data for a host in the United States, you would enter `geo.dest:US` in the search field, as shown in the following image.
|
||||
Dashboards Query Language (DQL) is a simple text-based query language for filtering data in OpenSearch Dashboards. Similar to [Query DSL]({{site.url}}{{site.baseurl}}/opensearch/query-dsl/index/), DQL uses an HTTP request body. For example, to display your site visitor data for a host in the United States, you would enter `geo.dest:US` in the search field, as shown in the following image.
|
||||
|
||||
<img src="{{site.url}}{{site.baseurl}}/images/dashboards/dql-interface.png" alt="Search term using DQL toolbar in Dashboard" width="500">
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: default
|
||||
title: Search telemetry
|
||||
nav_order: 130
|
||||
nav_order: 140
|
||||
---
|
||||
|
||||
|
||||
|
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Create pipeline
|
||||
parent: Ingest pipelines
|
||||
grand_parent: Ingest APIs
|
||||
nav_order: 10
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/ingest-apis/create-update-ingest/
|
||||
- /api-reference/ingest-apis/create-ingest/
|
||||
---
|
||||
|
||||
# Create pipeline
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Delete pipeline
|
||||
parent: Ingest pipelines
|
||||
grand_parent: Ingest APIs
|
||||
nav_order: 13
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/ingest-apis/delete-ingest/
|
||||
- /api-reference/ingest-apis/delete-ingest/
|
||||
---
|
||||
|
||||
# Delete pipeline
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Get pipeline
|
||||
parent: Ingest pipelines
|
||||
grand_parent: Ingest APIs
|
||||
nav_order: 12
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/ingest-apis/get-ingest/
|
||||
- /api-reference/ingest-apis/get-ingest/
|
||||
---
|
||||
|
||||
# Get pipeline
|
|
@ -1,14 +1,15 @@
|
|||
---
|
||||
layout: default
|
||||
title: Ingest pipelines
|
||||
parent: Ingest APIs
|
||||
has_children: true
|
||||
nav_order: 5
|
||||
nav_exclude: true
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/ingest-pipelines/
|
||||
---
|
||||
|
||||
# Ingest pipelines
|
||||
|
||||
An _ingest pipeline_ is a sequence of _processors_ that are applied to documents as they are ingested into an index. Each [processor]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/ingest-processors/) in a pipeline performs a specific task, such as filtering, transforming, or enriching data.
|
||||
An _ingest pipeline_ is a sequence of _processors_ that are applied to documents as they are ingested into an index. Each [processor]({{site.url}}{{site.baseurl}}/ingest-pipelines/processors/index-processors/) in a pipeline performs a specific task, such as filtering, transforming, or enriching data.
|
||||
|
||||
Processors are customizable tasks that run in a sequential order as they appear in the request body. This order is important, as each processor depends on the output of the previous processor. The modified documents appear in your index after the processors are applied.
|
||||
|
||||
|
@ -44,7 +45,7 @@ Field | Required | Type | Description
|
|||
|
||||
Learn how to:
|
||||
|
||||
- [Create a pipeline]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/create-ingest/).
|
||||
- [Test a pipeline]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/simulate-ingest/).
|
||||
- [Retrieve information about a pipeline]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/get-ingest/).
|
||||
- [Delete a pipeline]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/delete-ingest/).
|
||||
- [Create a pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/create-ingest/).
|
||||
- [Test a pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/simulate-ingest/).
|
||||
- [Retrieve information about a pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/get-ingest/).
|
||||
- [Delete a pipeline]({{site.url}}{{site.baseurl}}/ingest-pipelines/delete-ingest/).
|
|
@ -1,9 +1,9 @@
|
|||
---
|
||||
layout: default
|
||||
title: Handling pipeline failures
|
||||
parent: Ingest pipelines
|
||||
grand_parent: Ingest APIs
|
||||
nav_order: 15
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/pipeline-failures/
|
||||
---
|
||||
|
||||
# Handling pipeline failures
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
layout: default
|
||||
title: Append
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 10
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/append/
|
||||
---
|
||||
|
||||
|
||||
# Append
|
||||
|
||||
The `append` processor is used to add values to a field:
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Bytes
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 20
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/bytes/
|
||||
---
|
||||
|
||||
# Bytes
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Convert
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 30
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/convert/
|
||||
---
|
||||
|
||||
# Convert
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: CSV
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 40
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/csv/
|
||||
---
|
||||
|
||||
# CSV
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Date
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 50
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/date/
|
||||
---
|
||||
|
||||
# Date
|
|
@ -1,14 +1,15 @@
|
|||
---
|
||||
layout: default
|
||||
title: Ingest processors
|
||||
parent: Ingest APIs
|
||||
nav_order: 10
|
||||
nav_order: 30
|
||||
has_children: true
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/ingest-processors/
|
||||
---
|
||||
|
||||
# Ingest processors
|
||||
|
||||
Ingest processors are a core component of [ingest pipelines]({{site.url}}{{site.baseurl}}/api-reference/ingest-apis/ingest-pipelines/) because they preprocess documents before indexing. For example, you can remove fields, extract values from text, convert data formats, or append additional information.
|
||||
Ingest processors are a core component of [ingest pipelines]({{site.url}}{{site.baseurl}}/ingest-pipelines/index/). They preprocess documents before indexing. For example, you can remove fields, extract values from text, convert data formats, or append additional information.
|
||||
|
||||
OpenSearch provides a standard set of ingest processors within your OpenSearch installation. For a list of processors available in OpenSearch, use the [Nodes Info]({{site.url}}{{site.baseurl}}/api-reference/nodes-apis/nodes-info/) API operation:
|
||||
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: IP2Geo
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 130
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/ip2geo/
|
||||
---
|
||||
|
||||
# IP2Geo
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Lowercase
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 210
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/lowercase/
|
||||
---
|
||||
|
||||
# Lowercase
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Remove
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 230
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/remove/
|
||||
---
|
||||
|
||||
# Remove
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Sparse encoding
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 240
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/sparse-encoding/
|
||||
---
|
||||
|
||||
# Sparse encoding
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Text embedding
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 260
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/text-embedding/
|
||||
---
|
||||
|
||||
# Text embedding
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Text/image embedding
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 270
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/text-image-embedding/
|
||||
---
|
||||
|
||||
# Text/image embedding
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Uppercase
|
||||
parent: Ingest processors
|
||||
grand_parent: Ingest APIs
|
||||
parent: Ingest processors
|
||||
nav_order: 310
|
||||
redirect_from:
|
||||
- /api-reference/ingest-apis/processors/uppercase/
|
||||
---
|
||||
|
||||
# Uppercase
|
|
@ -1,11 +1,10 @@
|
|||
---
|
||||
layout: default
|
||||
title: Simulate pipeline
|
||||
parent: Ingest pipelines
|
||||
grand_parent: Ingest APIs
|
||||
nav_order: 11
|
||||
redirect_from:
|
||||
- /opensearch/rest-api/ingest-apis/simulate-ingest/
|
||||
- /api-reference/ingest-apis/simulate-ingest/
|
||||
---
|
||||
|
||||
# Simulate pipeline
|
Loading…
Reference in New Issue