From f3985b54d0e95bb12e4896607b33ffc8f4267e9a Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Mon, 16 Oct 2023 15:25:20 -0600 Subject: [PATCH 1/7] Change navigation for better usability Signed-off-by: Melissa Vagi --- _config.yml | 6 ++++++ _dashboards/branding.md | 2 +- _dashboards/discover/dql.md | 9 ++++----- .../ingest-pipelines}/create-ingest.md | 2 +- .../ingest-pipelines}/delete-ingest.md | 2 +- .../ingest-pipelines}/get-ingest.md | 2 +- .../ingest-pipelines}/ingest-pipelines.md | 3 ++- .../ingest-pipelines}/ingest-processors.md | 2 +- .../ingest-pipelines}/pipeline-failures.md | 3 ++- .../ingest-pipelines}/processors/append.md | 7 ++++--- .../ingest-pipelines}/processors/bytes.md | 6 ++++-- .../ingest-pipelines}/processors/convert.md | 6 ++++-- .../ingest-pipelines}/processors/csv.md | 6 ++++-- .../ingest-pipelines}/processors/date.md | 6 ++++-- .../ingest-pipelines}/processors/ip2geo.md | 6 ++++-- .../ingest-pipelines}/processors/lowercase.md | 6 ++++-- .../ingest-pipelines}/processors/remove.md | 6 ++++-- .../ingest-pipelines}/processors/sparse-encoding.md | 6 ++++-- .../ingest-pipelines}/processors/text-embedding.md | 6 ++++-- .../ingest-pipelines}/processors/text-image-embedding.md | 6 ++++-- .../ingest-pipelines}/processors/uppercase.md | 6 ++++-- .../ingest-pipelines}/simulate-ingest.md | 2 +- _dashboards/search-telemetry.md | 2 +- 23 files changed, 69 insertions(+), 39 deletions(-) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/create-ingest.md (98%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/delete-ingest.md (91%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/get-ingest.md (96%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/ingest-pipelines.md (97%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/ingest-processors.md (98%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/pipeline-failures.md (98%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/append.md (96%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/bytes.md (96%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/convert.md (96%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/csv.md (96%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/date.md (97%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/ip2geo.md (98%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/lowercase.md (95%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/remove.md (95%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/sparse-encoding.md (97%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/text-embedding.md (97%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/text-image-embedding.md (97%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/processors/uppercase.md (95%) rename {_api-reference/ingest-apis => _dashboards/ingest-pipelines}/simulate-ingest.md (99%) diff --git a/_config.yml b/_config.yml index 09cacabc1c..3e32fd8d94 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 b8e29b88ba..f4e4c1f4b7 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/discover/dql.md index 922f9a1039..a931dfb3aa 100644 --- a/_dashboards/discover/dql.md +++ b/_dashboards/discover/dql.md @@ -1,15 +1,14 @@ --- layout: default -title: Dashboards Query Language -parent: Discover -nav_order: 40 +title: Dashboards Query Language (DQL) +nav_order: 130 redirect_from: - /dashboards/dql/ --- -# Dashboards Query Language +# 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. +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/_api-reference/ingest-apis/create-ingest.md b/_dashboards/ingest-pipelines/create-ingest.md similarity index 98% rename from _api-reference/ingest-apis/create-ingest.md rename to _dashboards/ingest-pipelines/create-ingest.md index 38e9b32b54..a5780073cf 100644 --- a/_api-reference/ingest-apis/create-ingest.md +++ b/_dashboards/ingest-pipelines/create-ingest.md @@ -2,10 +2,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/_dashboards/ingest-pipelines/delete-ingest.md similarity index 91% rename from _api-reference/ingest-apis/delete-ingest.md rename to _dashboards/ingest-pipelines/delete-ingest.md index 59383fb0aa..57cce20412 100644 --- a/_api-reference/ingest-apis/delete-ingest.md +++ b/_dashboards/ingest-pipelines/delete-ingest.md @@ -2,10 +2,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/_dashboards/ingest-pipelines/get-ingest.md similarity index 96% rename from _api-reference/ingest-apis/get-ingest.md rename to _dashboards/ingest-pipelines/get-ingest.md index a56d7da584..873a6738d1 100644 --- a/_api-reference/ingest-apis/get-ingest.md +++ b/_dashboards/ingest-pipelines/get-ingest.md @@ -2,10 +2,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/_dashboards/ingest-pipelines/ingest-pipelines.md similarity index 97% rename from _api-reference/ingest-apis/ingest-pipelines.md rename to _dashboards/ingest-pipelines/ingest-pipelines.md index 38ea3fc7d5..071d63125f 100644 --- a/_api-reference/ingest-apis/ingest-pipelines.md +++ b/_dashboards/ingest-pipelines/ingest-pipelines.md @@ -1,9 +1,10 @@ --- layout: default title: Ingest pipelines -parent: Ingest APIs has_children: true nav_order: 5 +redirect_from: + - /api-reference/ingest-apis/ingest-pipelines/ --- # Ingest pipelines diff --git a/_api-reference/ingest-apis/ingest-processors.md b/_dashboards/ingest-pipelines/ingest-processors.md similarity index 98% rename from _api-reference/ingest-apis/ingest-processors.md rename to _dashboards/ingest-pipelines/ingest-processors.md index 5a9a5e0d41..1a99a32efa 100644 --- a/_api-reference/ingest-apis/ingest-processors.md +++ b/_dashboards/ingest-pipelines/ingest-processors.md @@ -1,7 +1,7 @@ --- layout: default title: Ingest processors -parent: Ingest APIs +parent: Ingest pipelines nav_order: 10 has_children: true --- diff --git a/_api-reference/ingest-apis/pipeline-failures.md b/_dashboards/ingest-pipelines/pipeline-failures.md similarity index 98% rename from _api-reference/ingest-apis/pipeline-failures.md rename to _dashboards/ingest-pipelines/pipeline-failures.md index f8814f39c2..1d41f6aab1 100644 --- a/_api-reference/ingest-apis/pipeline-failures.md +++ b/_dashboards/ingest-pipelines/pipeline-failures.md @@ -2,8 +2,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/_dashboards/ingest-pipelines/processors/append.md similarity index 96% rename from _api-reference/ingest-apis/processors/append.md rename to _dashboards/ingest-pipelines/processors/append.md index dee484a6aa..e157d03777 100644 --- a/_api-reference/ingest-apis/processors/append.md +++ b/_dashboards/ingest-pipelines/processors/append.md @@ -1,10 +1,11 @@ --- layout: default title: Append -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 10 ---- +redirect_from: + - /api-reference/ingest-apis/processors/append/ # Append diff --git a/_api-reference/ingest-apis/processors/bytes.md b/_dashboards/ingest-pipelines/processors/bytes.md similarity index 96% rename from _api-reference/ingest-apis/processors/bytes.md rename to _dashboards/ingest-pipelines/processors/bytes.md index 7d07766cbd..92dca6ae8f 100644 --- a/_api-reference/ingest-apis/processors/bytes.md +++ b/_dashboards/ingest-pipelines/processors/bytes.md @@ -1,9 +1,11 @@ --- layout: default title: Bytes -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 20 +redirect_from: + - /api-reference/ingest-apis/processors/bytes/ --- # Bytes diff --git a/_api-reference/ingest-apis/processors/convert.md b/_dashboards/ingest-pipelines/processors/convert.md similarity index 96% rename from _api-reference/ingest-apis/processors/convert.md rename to _dashboards/ingest-pipelines/processors/convert.md index 5b12c8e931..2f6595d612 100644 --- a/_api-reference/ingest-apis/processors/convert.md +++ b/_dashboards/ingest-pipelines/processors/convert.md @@ -1,9 +1,11 @@ --- layout: default title: Convert -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 30 +redirect_from: + - /api-reference/ingest-apis/processors/convert/ --- # Convert diff --git a/_api-reference/ingest-apis/processors/csv.md b/_dashboards/ingest-pipelines/processors/csv.md similarity index 96% rename from _api-reference/ingest-apis/processors/csv.md rename to _dashboards/ingest-pipelines/processors/csv.md index e4009e162b..46cb9215e4 100644 --- a/_api-reference/ingest-apis/processors/csv.md +++ b/_dashboards/ingest-pipelines/processors/csv.md @@ -1,9 +1,11 @@ --- layout: default title: CSV -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 40 +redirect_from: + - /api-reference/ingest-apis/processors/csv/ --- # CSV diff --git a/_api-reference/ingest-apis/processors/date.md b/_dashboards/ingest-pipelines/processors/date.md similarity index 97% rename from _api-reference/ingest-apis/processors/date.md rename to _dashboards/ingest-pipelines/processors/date.md index 46e9b9115f..9726ca2e36 100644 --- a/_api-reference/ingest-apis/processors/date.md +++ b/_dashboards/ingest-pipelines/processors/date.md @@ -1,9 +1,11 @@ --- layout: default title: Date -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 50 +redirect_from: + - /api-reference/ingest-apis/processors/date/ --- # Date diff --git a/_api-reference/ingest-apis/processors/ip2geo.md b/_dashboards/ingest-pipelines/processors/ip2geo.md similarity index 98% rename from _api-reference/ingest-apis/processors/ip2geo.md rename to _dashboards/ingest-pipelines/processors/ip2geo.md index 4883974a0b..cf2f676507 100644 --- a/_api-reference/ingest-apis/processors/ip2geo.md +++ b/_dashboards/ingest-pipelines/processors/ip2geo.md @@ -1,9 +1,11 @@ --- layout: default title: IP2Geo -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 130 +redirect_from: + - /api-reference/ingest-apis/processors/ip2geo/ --- # IP2Geo diff --git a/_api-reference/ingest-apis/processors/lowercase.md b/_dashboards/ingest-pipelines/processors/lowercase.md similarity index 95% rename from _api-reference/ingest-apis/processors/lowercase.md rename to _dashboards/ingest-pipelines/processors/lowercase.md index 535875ff7d..ee71f8ab67 100644 --- a/_api-reference/ingest-apis/processors/lowercase.md +++ b/_dashboards/ingest-pipelines/processors/lowercase.md @@ -1,9 +1,11 @@ --- layout: default title: Lowercase -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 210 +redirect_from: + - /api-reference/ingest-apis/processors/lowercase/ --- # Lowercase diff --git a/_api-reference/ingest-apis/processors/remove.md b/_dashboards/ingest-pipelines/processors/remove.md similarity index 95% rename from _api-reference/ingest-apis/processors/remove.md rename to _dashboards/ingest-pipelines/processors/remove.md index db233a0b08..2d45d7a50d 100644 --- a/_api-reference/ingest-apis/processors/remove.md +++ b/_dashboards/ingest-pipelines/processors/remove.md @@ -1,9 +1,11 @@ --- layout: default title: Remove -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 230 +redirect_from: + - /api-reference/ingest-apis/processors/remove/ --- # Remove diff --git a/_api-reference/ingest-apis/processors/sparse-encoding.md b/_dashboards/ingest-pipelines/processors/sparse-encoding.md similarity index 97% rename from _api-reference/ingest-apis/processors/sparse-encoding.md rename to _dashboards/ingest-pipelines/processors/sparse-encoding.md index 7c1eda362a..05e8858882 100644 --- a/_api-reference/ingest-apis/processors/sparse-encoding.md +++ b/_dashboards/ingest-pipelines/processors/sparse-encoding.md @@ -1,9 +1,11 @@ --- layout: default title: Sparse encoding -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines 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/_dashboards/ingest-pipelines/processors/text-embedding.md similarity index 97% rename from _api-reference/ingest-apis/processors/text-embedding.md rename to _dashboards/ingest-pipelines/processors/text-embedding.md index e81bbb82d1..2a3cc084e7 100644 --- a/_api-reference/ingest-apis/processors/text-embedding.md +++ b/_dashboards/ingest-pipelines/processors/text-embedding.md @@ -1,9 +1,11 @@ --- layout: default title: Text embedding -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines 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/_dashboards/ingest-pipelines/processors/text-image-embedding.md similarity index 97% rename from _api-reference/ingest-apis/processors/text-image-embedding.md rename to _dashboards/ingest-pipelines/processors/text-image-embedding.md index 57ce7bf3d4..924f67bab2 100644 --- a/_api-reference/ingest-apis/processors/text-image-embedding.md +++ b/_dashboards/ingest-pipelines/processors/text-image-embedding.md @@ -1,9 +1,11 @@ --- layout: default title: Text/image embedding -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines 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/_dashboards/ingest-pipelines/processors/uppercase.md similarity index 95% rename from _api-reference/ingest-apis/processors/uppercase.md rename to _dashboards/ingest-pipelines/processors/uppercase.md index 6ea5ebb137..0c7e9b8c7c 100644 --- a/_api-reference/ingest-apis/processors/uppercase.md +++ b/_dashboards/ingest-pipelines/processors/uppercase.md @@ -1,9 +1,11 @@ --- layout: default title: Uppercase -parent: Ingest processors -grand_parent: Ingest APIs +parent: Ingest processors +grand_parent: Ingest pipelines nav_order: 310 +redirect_from: + - /api-reference/ingest-apis/processors/uppercase/ --- # Uppercase diff --git a/_api-reference/ingest-apis/simulate-ingest.md b/_dashboards/ingest-pipelines/simulate-ingest.md similarity index 99% rename from _api-reference/ingest-apis/simulate-ingest.md rename to _dashboards/ingest-pipelines/simulate-ingest.md index 9ca40b791c..0b406b1d3a 100644 --- a/_api-reference/ingest-apis/simulate-ingest.md +++ b/_dashboards/ingest-pipelines/simulate-ingest.md @@ -2,10 +2,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 diff --git a/_dashboards/search-telemetry.md b/_dashboards/search-telemetry.md index f4cfccf843..3b9af82b82 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 --- From 0f178219f668bc46a32b983bcee01bd88417dfad Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Mon, 16 Oct 2023 15:51:28 -0600 Subject: [PATCH 2/7] Fix folder structure Signed-off-by: Melissa Vagi --- _dashboards/{discover => }/dql.md | 1 + .../create-ingest.md | 0 .../delete-ingest.md | 0 .../get-ingest.md | 0 .../ingest-pipelines.md | 10 +++++----- .../ingest-processors.md | 0 .../pipeline-failures.md | 0 .../processors/append.md | 0 .../processors/bytes.md | 0 .../processors/convert.md | 0 .../processors/csv.md | 0 .../processors/date.md | 0 .../processors/ip2geo.md | 0 .../processors/lowercase.md | 0 .../processors/remove.md | 0 .../processors/sparse-encoding.md | 0 .../processors/text-embedding.md | 0 .../processors/text-image-embedding.md | 0 .../processors/uppercase.md | 0 .../simulate-ingest.md | 0 20 files changed, 6 insertions(+), 5 deletions(-) rename _dashboards/{discover => }/dql.md (99%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/create-ingest.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/delete-ingest.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/get-ingest.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/ingest-pipelines.md (78%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/ingest-processors.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/pipeline-failures.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/append.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/bytes.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/convert.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/csv.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/date.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/ip2geo.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/lowercase.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/remove.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/sparse-encoding.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/text-embedding.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/text-image-embedding.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/processors/uppercase.md (100%) rename {_dashboards/ingest-pipelines => _ingest-pipelines}/simulate-ingest.md (100%) diff --git a/_dashboards/discover/dql.md b/_dashboards/dql.md similarity index 99% rename from _dashboards/discover/dql.md rename to _dashboards/dql.md index a931dfb3aa..10bd912385 100644 --- a/_dashboards/discover/dql.md +++ b/_dashboards/dql.md @@ -4,6 +4,7 @@ title: Dashboards Query Language (DQL) nav_order: 130 redirect_from: - /dashboards/dql/ + - /dashboards/discover/dql/ --- # Dashboards Query Language (DQL) diff --git a/_dashboards/ingest-pipelines/create-ingest.md b/_ingest-pipelines/create-ingest.md similarity index 100% rename from _dashboards/ingest-pipelines/create-ingest.md rename to _ingest-pipelines/create-ingest.md diff --git a/_dashboards/ingest-pipelines/delete-ingest.md b/_ingest-pipelines/delete-ingest.md similarity index 100% rename from _dashboards/ingest-pipelines/delete-ingest.md rename to _ingest-pipelines/delete-ingest.md diff --git a/_dashboards/ingest-pipelines/get-ingest.md b/_ingest-pipelines/get-ingest.md similarity index 100% rename from _dashboards/ingest-pipelines/get-ingest.md rename to _ingest-pipelines/get-ingest.md diff --git a/_dashboards/ingest-pipelines/ingest-pipelines.md b/_ingest-pipelines/ingest-pipelines.md similarity index 78% rename from _dashboards/ingest-pipelines/ingest-pipelines.md rename to _ingest-pipelines/ingest-pipelines.md index 071d63125f..350126bed2 100644 --- a/_dashboards/ingest-pipelines/ingest-pipelines.md +++ b/_ingest-pipelines/ingest-pipelines.md @@ -9,7 +9,7 @@ redirect_from: # 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/ingest-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. @@ -45,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/_dashboards/ingest-pipelines/ingest-processors.md b/_ingest-pipelines/ingest-processors.md similarity index 100% rename from _dashboards/ingest-pipelines/ingest-processors.md rename to _ingest-pipelines/ingest-processors.md diff --git a/_dashboards/ingest-pipelines/pipeline-failures.md b/_ingest-pipelines/pipeline-failures.md similarity index 100% rename from _dashboards/ingest-pipelines/pipeline-failures.md rename to _ingest-pipelines/pipeline-failures.md diff --git a/_dashboards/ingest-pipelines/processors/append.md b/_ingest-pipelines/processors/append.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/append.md rename to _ingest-pipelines/processors/append.md diff --git a/_dashboards/ingest-pipelines/processors/bytes.md b/_ingest-pipelines/processors/bytes.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/bytes.md rename to _ingest-pipelines/processors/bytes.md diff --git a/_dashboards/ingest-pipelines/processors/convert.md b/_ingest-pipelines/processors/convert.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/convert.md rename to _ingest-pipelines/processors/convert.md diff --git a/_dashboards/ingest-pipelines/processors/csv.md b/_ingest-pipelines/processors/csv.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/csv.md rename to _ingest-pipelines/processors/csv.md diff --git a/_dashboards/ingest-pipelines/processors/date.md b/_ingest-pipelines/processors/date.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/date.md rename to _ingest-pipelines/processors/date.md diff --git a/_dashboards/ingest-pipelines/processors/ip2geo.md b/_ingest-pipelines/processors/ip2geo.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/ip2geo.md rename to _ingest-pipelines/processors/ip2geo.md diff --git a/_dashboards/ingest-pipelines/processors/lowercase.md b/_ingest-pipelines/processors/lowercase.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/lowercase.md rename to _ingest-pipelines/processors/lowercase.md diff --git a/_dashboards/ingest-pipelines/processors/remove.md b/_ingest-pipelines/processors/remove.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/remove.md rename to _ingest-pipelines/processors/remove.md diff --git a/_dashboards/ingest-pipelines/processors/sparse-encoding.md b/_ingest-pipelines/processors/sparse-encoding.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/sparse-encoding.md rename to _ingest-pipelines/processors/sparse-encoding.md diff --git a/_dashboards/ingest-pipelines/processors/text-embedding.md b/_ingest-pipelines/processors/text-embedding.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/text-embedding.md rename to _ingest-pipelines/processors/text-embedding.md diff --git a/_dashboards/ingest-pipelines/processors/text-image-embedding.md b/_ingest-pipelines/processors/text-image-embedding.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/text-image-embedding.md rename to _ingest-pipelines/processors/text-image-embedding.md diff --git a/_dashboards/ingest-pipelines/processors/uppercase.md b/_ingest-pipelines/processors/uppercase.md similarity index 100% rename from _dashboards/ingest-pipelines/processors/uppercase.md rename to _ingest-pipelines/processors/uppercase.md diff --git a/_dashboards/ingest-pipelines/simulate-ingest.md b/_ingest-pipelines/simulate-ingest.md similarity index 100% rename from _dashboards/ingest-pipelines/simulate-ingest.md rename to _ingest-pipelines/simulate-ingest.md From de28ebee59c166667ca5a55323ef35ce2d7b35b7 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 17 Oct 2023 10:16:45 -0600 Subject: [PATCH 3/7] Fix links Signed-off-by: Melissa Vagi --- _ingest-pipelines/{ingest-pipelines.md => index.md} | 0 .../index-processors.md} | 6 ++++-- 2 files changed, 4 insertions(+), 2 deletions(-) rename _ingest-pipelines/{ingest-pipelines.md => index.md} (100%) rename _ingest-pipelines/{ingest-processors.md => processors/index-processors.md} (78%) diff --git a/_ingest-pipelines/ingest-pipelines.md b/_ingest-pipelines/index.md similarity index 100% rename from _ingest-pipelines/ingest-pipelines.md rename to _ingest-pipelines/index.md diff --git a/_ingest-pipelines/ingest-processors.md b/_ingest-pipelines/processors/index-processors.md similarity index 78% rename from _ingest-pipelines/ingest-processors.md rename to _ingest-pipelines/processors/index-processors.md index 1a99a32efa..6c96412b35 100644 --- a/_ingest-pipelines/ingest-processors.md +++ b/_ingest-pipelines/processors/index-processors.md @@ -2,13 +2,15 @@ layout: default title: Ingest processors parent: Ingest pipelines -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: From 4ba1ddb5ce1b47df13fbfa16ece08e5287d79113 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 17 Oct 2023 11:36:31 -0600 Subject: [PATCH 4/7] Fix front matter Signed-off-by: Melissa Vagi --- _ingest-pipelines/processors/append.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/_ingest-pipelines/processors/append.md b/_ingest-pipelines/processors/append.md index e157d03777..3ad8388cb3 100644 --- a/_ingest-pipelines/processors/append.md +++ b/_ingest-pipelines/processors/append.md @@ -6,7 +6,8 @@ grand_parent: Ingest pipelines nav_order: 10 redirect_from: - /api-reference/ingest-apis/processors/append/ - +--- + # Append The `append` processor is used to add values to a field: From b3460e1ea8286488f35871701f8fce9f49701ed8 Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 17 Oct 2023 11:39:38 -0600 Subject: [PATCH 5/7] Fix link Signed-off-by: Melissa Vagi --- _ingest-pipelines/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_ingest-pipelines/index.md b/_ingest-pipelines/index.md index 350126bed2..696915c851 100644 --- a/_ingest-pipelines/index.md +++ b/_ingest-pipelines/index.md @@ -9,7 +9,7 @@ redirect_from: # 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}}/ingest-pipelines/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. From bfb3953f6061d19c1cdda771756516218afacab7 Mon Sep 17 00:00:00 2001 From: Fanit Kolchina Date: Tue, 17 Oct 2023 16:35:19 -0400 Subject: [PATCH 6/7] Remove duplicate parent page and fix navigation for new pages Signed-off-by: Fanit Kolchina --- _api-reference/ingest-apis/index.md | 2 +- _ingest-pipelines/create-ingest.md | 1 - _ingest-pipelines/delete-ingest.md | 1 - _ingest-pipelines/get-ingest.md | 1 - _ingest-pipelines/index.md | 2 +- _ingest-pipelines/pipeline-failures.md | 1 - _ingest-pipelines/processors/append.md | 1 - _ingest-pipelines/processors/bytes.md | 1 - _ingest-pipelines/processors/convert.md | 1 - _ingest-pipelines/processors/csv.md | 1 - _ingest-pipelines/processors/date.md | 1 - _ingest-pipelines/processors/index-processors.md | 1 - _ingest-pipelines/processors/ip2geo.md | 1 - _ingest-pipelines/processors/lowercase.md | 1 - _ingest-pipelines/processors/remove.md | 1 - _ingest-pipelines/processors/sparse-encoding.md | 1 - _ingest-pipelines/processors/text-embedding.md | 1 - _ingest-pipelines/processors/text-image-embedding.md | 1 - _ingest-pipelines/processors/uppercase.md | 1 - _ingest-pipelines/simulate-ingest.md | 1 - 20 files changed, 2 insertions(+), 20 deletions(-) diff --git a/_api-reference/ingest-apis/index.md b/_api-reference/ingest-apis/index.md index 462c699fc2..26cb87c303 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/_ingest-pipelines/create-ingest.md b/_ingest-pipelines/create-ingest.md index a5780073cf..3f756b8740 100644 --- a/_ingest-pipelines/create-ingest.md +++ b/_ingest-pipelines/create-ingest.md @@ -1,7 +1,6 @@ --- layout: default title: Create pipeline -parent: Ingest pipelines nav_order: 10 redirect_from: - /opensearch/rest-api/ingest-apis/create-update-ingest/ diff --git a/_ingest-pipelines/delete-ingest.md b/_ingest-pipelines/delete-ingest.md index 57cce20412..b82df1d0c4 100644 --- a/_ingest-pipelines/delete-ingest.md +++ b/_ingest-pipelines/delete-ingest.md @@ -1,7 +1,6 @@ --- layout: default title: Delete pipeline -parent: Ingest pipelines nav_order: 13 redirect_from: - /opensearch/rest-api/ingest-apis/delete-ingest/ diff --git a/_ingest-pipelines/get-ingest.md b/_ingest-pipelines/get-ingest.md index 873a6738d1..aadd3895fc 100644 --- a/_ingest-pipelines/get-ingest.md +++ b/_ingest-pipelines/get-ingest.md @@ -1,7 +1,6 @@ --- layout: default title: Get pipeline -parent: Ingest pipelines nav_order: 12 redirect_from: - /opensearch/rest-api/ingest-apis/get-ingest/ diff --git a/_ingest-pipelines/index.md b/_ingest-pipelines/index.md index 696915c851..1c166ec847 100644 --- a/_ingest-pipelines/index.md +++ b/_ingest-pipelines/index.md @@ -1,8 +1,8 @@ --- layout: default title: Ingest pipelines -has_children: true nav_order: 5 +nav_exclude: true redirect_from: - /api-reference/ingest-apis/ingest-pipelines/ --- diff --git a/_ingest-pipelines/pipeline-failures.md b/_ingest-pipelines/pipeline-failures.md index 1d41f6aab1..f89434faf4 100644 --- a/_ingest-pipelines/pipeline-failures.md +++ b/_ingest-pipelines/pipeline-failures.md @@ -1,7 +1,6 @@ --- layout: default title: Handling pipeline failures -parent: Ingest pipelines nav_order: 15 redirect_from: - /api-reference/ingest-apis/pipeline-failures/ diff --git a/_ingest-pipelines/processors/append.md b/_ingest-pipelines/processors/append.md index 3ad8388cb3..b9d05aa6b0 100644 --- a/_ingest-pipelines/processors/append.md +++ b/_ingest-pipelines/processors/append.md @@ -2,7 +2,6 @@ layout: default title: Append parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 10 redirect_from: - /api-reference/ingest-apis/processors/append/ diff --git a/_ingest-pipelines/processors/bytes.md b/_ingest-pipelines/processors/bytes.md index 92dca6ae8f..ce1dbede9b 100644 --- a/_ingest-pipelines/processors/bytes.md +++ b/_ingest-pipelines/processors/bytes.md @@ -2,7 +2,6 @@ layout: default title: Bytes parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 20 redirect_from: - /api-reference/ingest-apis/processors/bytes/ diff --git a/_ingest-pipelines/processors/convert.md b/_ingest-pipelines/processors/convert.md index 2f6595d612..2616ffe8e4 100644 --- a/_ingest-pipelines/processors/convert.md +++ b/_ingest-pipelines/processors/convert.md @@ -2,7 +2,6 @@ layout: default title: Convert parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 30 redirect_from: - /api-reference/ingest-apis/processors/convert/ diff --git a/_ingest-pipelines/processors/csv.md b/_ingest-pipelines/processors/csv.md index 46cb9215e4..2d42faf88c 100644 --- a/_ingest-pipelines/processors/csv.md +++ b/_ingest-pipelines/processors/csv.md @@ -2,7 +2,6 @@ layout: default title: CSV parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 40 redirect_from: - /api-reference/ingest-apis/processors/csv/ diff --git a/_ingest-pipelines/processors/date.md b/_ingest-pipelines/processors/date.md index 9726ca2e36..9e35cc8bc8 100644 --- a/_ingest-pipelines/processors/date.md +++ b/_ingest-pipelines/processors/date.md @@ -2,7 +2,6 @@ layout: default title: Date parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 50 redirect_from: - /api-reference/ingest-apis/processors/date/ diff --git a/_ingest-pipelines/processors/index-processors.md b/_ingest-pipelines/processors/index-processors.md index 6c96412b35..58ea1d2392 100644 --- a/_ingest-pipelines/processors/index-processors.md +++ b/_ingest-pipelines/processors/index-processors.md @@ -1,7 +1,6 @@ --- layout: default title: Ingest processors -parent: Ingest pipelines nav_order: 30 has_children: true redirect_from: diff --git a/_ingest-pipelines/processors/ip2geo.md b/_ingest-pipelines/processors/ip2geo.md index cf2f676507..87a6763c91 100644 --- a/_ingest-pipelines/processors/ip2geo.md +++ b/_ingest-pipelines/processors/ip2geo.md @@ -2,7 +2,6 @@ layout: default title: IP2Geo parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 130 redirect_from: - /api-reference/ingest-apis/processors/ip2geo/ diff --git a/_ingest-pipelines/processors/lowercase.md b/_ingest-pipelines/processors/lowercase.md index ee71f8ab67..5b2de2fadf 100644 --- a/_ingest-pipelines/processors/lowercase.md +++ b/_ingest-pipelines/processors/lowercase.md @@ -2,7 +2,6 @@ layout: default title: Lowercase parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 210 redirect_from: - /api-reference/ingest-apis/processors/lowercase/ diff --git a/_ingest-pipelines/processors/remove.md b/_ingest-pipelines/processors/remove.md index 2d45d7a50d..a58b9e7521 100644 --- a/_ingest-pipelines/processors/remove.md +++ b/_ingest-pipelines/processors/remove.md @@ -2,7 +2,6 @@ layout: default title: Remove parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 230 redirect_from: - /api-reference/ingest-apis/processors/remove/ diff --git a/_ingest-pipelines/processors/sparse-encoding.md b/_ingest-pipelines/processors/sparse-encoding.md index 05e8858882..45d81460a0 100644 --- a/_ingest-pipelines/processors/sparse-encoding.md +++ b/_ingest-pipelines/processors/sparse-encoding.md @@ -2,7 +2,6 @@ layout: default title: Sparse encoding parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 240 redirect_from: - /api-reference/ingest-apis/processors/sparse-encoding/ diff --git a/_ingest-pipelines/processors/text-embedding.md b/_ingest-pipelines/processors/text-embedding.md index 2a3cc084e7..4115851883 100644 --- a/_ingest-pipelines/processors/text-embedding.md +++ b/_ingest-pipelines/processors/text-embedding.md @@ -2,7 +2,6 @@ layout: default title: Text embedding parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 260 redirect_from: - /api-reference/ingest-apis/processors/text-embedding/ diff --git a/_ingest-pipelines/processors/text-image-embedding.md b/_ingest-pipelines/processors/text-image-embedding.md index 924f67bab2..6b7efe7e7a 100644 --- a/_ingest-pipelines/processors/text-image-embedding.md +++ b/_ingest-pipelines/processors/text-image-embedding.md @@ -2,7 +2,6 @@ layout: default title: Text/image embedding parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 270 redirect_from: - /api-reference/ingest-apis/processors/text-image-embedding/ diff --git a/_ingest-pipelines/processors/uppercase.md b/_ingest-pipelines/processors/uppercase.md index 0c7e9b8c7c..cecb9758ae 100644 --- a/_ingest-pipelines/processors/uppercase.md +++ b/_ingest-pipelines/processors/uppercase.md @@ -2,7 +2,6 @@ layout: default title: Uppercase parent: Ingest processors -grand_parent: Ingest pipelines nav_order: 310 redirect_from: - /api-reference/ingest-apis/processors/uppercase/ diff --git a/_ingest-pipelines/simulate-ingest.md b/_ingest-pipelines/simulate-ingest.md index 0b406b1d3a..413f2fed8c 100644 --- a/_ingest-pipelines/simulate-ingest.md +++ b/_ingest-pipelines/simulate-ingest.md @@ -1,7 +1,6 @@ --- layout: default title: Simulate pipeline -parent: Ingest pipelines nav_order: 11 redirect_from: - /opensearch/rest-api/ingest-apis/simulate-ingest/ From 688b24aba7c92394c5d54e5021823dfe4eb244df Mon Sep 17 00:00:00 2001 From: Melissa Vagi Date: Tue, 17 Oct 2023 15:11:52 -0600 Subject: [PATCH 7/7] Copy edits Signed-off-by: Melissa Vagi --- _dashboards/dql.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_dashboards/dql.md b/_dashboards/dql.md index 10bd912385..ae5f56c651 100644 --- a/_dashboards/dql.md +++ b/_dashboards/dql.md @@ -1,15 +1,15 @@ --- layout: default -title: Dashboards Query Language (DQL) +title: DQL nav_order: 130 redirect_from: - /dashboards/dql/ - /dashboards/discover/dql/ --- -# Dashboards Query Language (DQL) +# DQL -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