From 1f810493bdca2a06983b848ab22c98118d0dd510 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 17 Oct 2023 15:22:28 -0600 Subject: [PATCH] [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 --------- Signed-off-by: Melissa Vagi Signed-off-by: Fanit Kolchina Co-authored-by: Fanit Kolchina --- _api-reference/ingest-apis/index.md | 2 +- _config.yml | 6 ++++++ _dashboards/branding.md | 2 +- _dashboards/{discover => }/dql.md | 10 +++++----- _dashboards/search-telemetry.md | 2 +- .../create-ingest.md | 3 +-- .../delete-ingest.md | 3 +-- .../get-ingest.md | 3 +-- .../index.md | 15 ++++++++------- .../pipeline-failures.md | 4 ++-- .../processors/append.md | 7 ++++--- .../processors/bytes.md | 5 +++-- .../processors/convert.md | 5 +++-- .../processors/csv.md | 5 +++-- .../processors/date.md | 5 +++-- .../processors/index-processors.md | 7 ++++--- .../processors/ip2geo.md | 5 +++-- .../processors/lowercase.md | 5 +++-- .../processors/remove.md | 5 +++-- .../processors/sparse-encoding.md | 5 +++-- .../processors/text-embedding.md | 5 +++-- .../processors/text-image-embedding.md | 5 +++-- .../processors/uppercase.md | 5 +++-- .../simulate-ingest.md | 3 +-- 24 files changed, 69 insertions(+), 53 deletions(-) rename _dashboards/{discover => }/dql.md (94%) rename {_api-reference/ingest-apis => _ingest-pipelines}/create-ingest.md (98%) rename {_api-reference/ingest-apis => _ingest-pipelines}/delete-ingest.md (90%) rename {_api-reference/ingest-apis => _ingest-pipelines}/get-ingest.md (96%) rename _api-reference/ingest-apis/ingest-pipelines.md => _ingest-pipelines/index.md (76%) rename {_api-reference/ingest-apis => _ingest-pipelines}/pipeline-failures.md (98%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/append.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/bytes.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/convert.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/csv.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/date.md (97%) rename _api-reference/ingest-apis/ingest-processors.md => _ingest-pipelines/processors/index-processors.md (77%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/ip2geo.md (98%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/lowercase.md (96%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/remove.md (96%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/sparse-encoding.md (98%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/text-embedding.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/text-image-embedding.md (97%) rename {_api-reference/ingest-apis => _ingest-pipelines}/processors/uppercase.md (96%) rename {_api-reference/ingest-apis => _ingest-pipelines}/simulate-ingest.md (99%) diff --git a/_api-reference/ingest-apis/index.md b/_api-reference/ingest-apis/index.md index 462c699fc2e..26cb87c3037 100644 --- a/_api-reference/ingest-apis/index.md +++ b/_api-reference/ingest-apis/index.md @@ -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/ diff --git a/_config.yml b/_config.yml index 99ed191eca3..63a6c9ff8e9 100644 --- a/_config.yml +++ b/_config.yml @@ -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 diff --git a/_dashboards/branding.md b/_dashboards/branding.md index b8e29b88ba5..f4e4c1f4b74 100644 --- a/_dashboards/branding.md +++ b/_dashboards/branding.md @@ -1,7 +1,7 @@ --- layout: default title: Custom branding -nav_order: 125 +nav_order: 130 --- # Custom branding diff --git a/_dashboards/discover/dql.md b/_dashboards/dql.md similarity index 94% rename from _dashboards/discover/dql.md rename to _dashboards/dql.md index 922f9a1039b..ae5f56c6510 100644 --- a/_dashboards/discover/dql.md +++ b/_dashboards/dql.md @@ -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. Search term using DQL toolbar in Dashboard diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index f4cfccf8430..3b9af82b827 100644 --- a/_dashboards/search-telemetry.md +++ b/_dashboards/search-telemetry.md @@ -1,7 +1,7 @@ --- layout: default title: Search telemetry -nav_order: 130 +nav_order: 140 --- diff --git a/_api-reference/ingest-apis/create-ingest.md b/_ingest-pipelines/create-ingest.md similarity index 98% rename from _api-reference/ingest-apis/create-ingest.md rename to _ingest-pipelines/create-ingest.md index 38e9b32b54c..3f756b87403 100644 --- a/_api-reference/ingest-apis/create-ingest.md +++ b/_ingest-pipelines/create-ingest.md @@ -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 diff --git a/_api-reference/ingest-apis/delete-ingest.md b/_ingest-pipelines/delete-ingest.md similarity index 90% rename from _api-reference/ingest-apis/delete-ingest.md rename to _ingest-pipelines/delete-ingest.md index 59383fb0aac..b82df1d0c49 100644 --- a/_api-reference/ingest-apis/delete-ingest.md +++ b/_ingest-pipelines/delete-ingest.md @@ -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 diff --git a/_api-reference/ingest-apis/get-ingest.md b/_ingest-pipelines/get-ingest.md similarity index 96% rename from _api-reference/ingest-apis/get-ingest.md rename to _ingest-pipelines/get-ingest.md index a56d7da5842..aadd3895fc6 100644 --- a/_api-reference/ingest-apis/get-ingest.md +++ b/_ingest-pipelines/get-ingest.md @@ -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 diff --git a/_api-reference/ingest-apis/ingest-pipelines.md b/_ingest-pipelines/index.md similarity index 76% rename from _api-reference/ingest-apis/ingest-pipelines.md rename to _ingest-pipelines/index.md index 38ea3fc7d53..1c166ec8477 100644 --- a/_api-reference/ingest-apis/ingest-pipelines.md +++ b/_ingest-pipelines/index.md @@ -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/). diff --git a/_api-reference/ingest-apis/pipeline-failures.md b/_ingest-pipelines/pipeline-failures.md similarity index 98% rename from _api-reference/ingest-apis/pipeline-failures.md rename to _ingest-pipelines/pipeline-failures.md index f8814f39c28..f89434faf4e 100644 --- a/_api-reference/ingest-apis/pipeline-failures.md +++ b/_ingest-pipelines/pipeline-failures.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/append.md b/_ingest-pipelines/processors/append.md similarity index 97% rename from _api-reference/ingest-apis/processors/append.md rename to _ingest-pipelines/processors/append.md index dee484a6aaf..b9d05aa6b0a 100644 --- a/_api-reference/ingest-apis/processors/append.md +++ b/_ingest-pipelines/processors/append.md @@ -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: diff --git a/_api-reference/ingest-apis/processors/bytes.md b/_ingest-pipelines/processors/bytes.md similarity index 97% rename from _api-reference/ingest-apis/processors/bytes.md rename to _ingest-pipelines/processors/bytes.md index 7d07766cbd4..ce1dbede9b2 100644 --- a/_api-reference/ingest-apis/processors/bytes.md +++ b/_ingest-pipelines/processors/bytes.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/convert.md b/_ingest-pipelines/processors/convert.md similarity index 97% rename from _api-reference/ingest-apis/processors/convert.md rename to _ingest-pipelines/processors/convert.md index 5b12c8e931f..2616ffe8e48 100644 --- a/_api-reference/ingest-apis/processors/convert.md +++ b/_ingest-pipelines/processors/convert.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/csv.md b/_ingest-pipelines/processors/csv.md similarity index 97% rename from _api-reference/ingest-apis/processors/csv.md rename to _ingest-pipelines/processors/csv.md index e4009e162b7..2d42faf88ce 100644 --- a/_api-reference/ingest-apis/processors/csv.md +++ b/_ingest-pipelines/processors/csv.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/date.md b/_ingest-pipelines/processors/date.md similarity index 97% rename from _api-reference/ingest-apis/processors/date.md rename to _ingest-pipelines/processors/date.md index 46e9b9115f0..9e35cc8bc8c 100644 --- a/_api-reference/ingest-apis/processors/date.md +++ b/_ingest-pipelines/processors/date.md @@ -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 diff --git a/_api-reference/ingest-apis/ingest-processors.md b/_ingest-pipelines/processors/index-processors.md similarity index 77% rename from _api-reference/ingest-apis/ingest-processors.md rename to _ingest-pipelines/processors/index-processors.md index 5a9a5e0d412..58ea1d2392d 100644 --- a/_api-reference/ingest-apis/ingest-processors.md +++ b/_ingest-pipelines/processors/index-processors.md @@ -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: diff --git a/_api-reference/ingest-apis/processors/ip2geo.md b/_ingest-pipelines/processors/ip2geo.md similarity index 98% rename from _api-reference/ingest-apis/processors/ip2geo.md rename to _ingest-pipelines/processors/ip2geo.md index 4883974a0b6..87a6763c918 100644 --- a/_api-reference/ingest-apis/processors/ip2geo.md +++ b/_ingest-pipelines/processors/ip2geo.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/lowercase.md b/_ingest-pipelines/processors/lowercase.md similarity index 96% rename from _api-reference/ingest-apis/processors/lowercase.md rename to _ingest-pipelines/processors/lowercase.md index 535875ff7d1..5b2de2fadf7 100644 --- a/_api-reference/ingest-apis/processors/lowercase.md +++ b/_ingest-pipelines/processors/lowercase.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/remove.md b/_ingest-pipelines/processors/remove.md similarity index 96% rename from _api-reference/ingest-apis/processors/remove.md rename to _ingest-pipelines/processors/remove.md index db233a0b083..a58b9e75212 100644 --- a/_api-reference/ingest-apis/processors/remove.md +++ b/_ingest-pipelines/processors/remove.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/sparse-encoding.md b/_ingest-pipelines/processors/sparse-encoding.md similarity index 98% rename from _api-reference/ingest-apis/processors/sparse-encoding.md rename to _ingest-pipelines/processors/sparse-encoding.md index 7c1eda362a8..45d81460a0e 100644 --- a/_api-reference/ingest-apis/processors/sparse-encoding.md +++ b/_ingest-pipelines/processors/sparse-encoding.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/text-embedding.md b/_ingest-pipelines/processors/text-embedding.md similarity index 97% rename from _api-reference/ingest-apis/processors/text-embedding.md rename to _ingest-pipelines/processors/text-embedding.md index e81bbb82d11..4115851883f 100644 --- a/_api-reference/ingest-apis/processors/text-embedding.md +++ b/_ingest-pipelines/processors/text-embedding.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/text-image-embedding.md b/_ingest-pipelines/processors/text-image-embedding.md similarity index 97% rename from _api-reference/ingest-apis/processors/text-image-embedding.md rename to _ingest-pipelines/processors/text-image-embedding.md index 57ce7bf3d46..6b7efe7e7aa 100644 --- a/_api-reference/ingest-apis/processors/text-image-embedding.md +++ b/_ingest-pipelines/processors/text-image-embedding.md @@ -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 diff --git a/_api-reference/ingest-apis/processors/uppercase.md b/_ingest-pipelines/processors/uppercase.md similarity index 96% rename from _api-reference/ingest-apis/processors/uppercase.md rename to _ingest-pipelines/processors/uppercase.md index 6ea5ebb1370..cecb9758ae5 100644 --- a/_api-reference/ingest-apis/processors/uppercase.md +++ b/_ingest-pipelines/processors/uppercase.md @@ -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 diff --git a/_api-reference/ingest-apis/simulate-ingest.md b/_ingest-pipelines/simulate-ingest.md similarity index 99% rename from _api-reference/ingest-apis/simulate-ingest.md rename to _ingest-pipelines/simulate-ingest.md index 9ca40b791cb..413f2fed8c1 100644 --- a/_api-reference/ingest-apis/simulate-ingest.md +++ b/_ingest-pipelines/simulate-ingest.md @@ -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