[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 <[email protected]> --------- Signed-off-by: Melissa Vagi <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]>
opensearch-project · Oct 17, 2023 · 27798ba · 27798ba
1 parent 7a5a381
commit 27798ba
Show file tree

Hide file tree

Showing 24 changed files with 69 additions and 53 deletions.
diff --git 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
@@ -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
@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Custom branding
-nav_order: 125
+nav_order: 130
 ---
 
 # Custom branding

diff --git a/_dashboards/discover/dql.md → _dashboards/dql.md b/_dashboards/discover/dql.md → _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.
 
 <img src="{{site.url}}{{site.baseurl}}/images/dashboards/dql-interface.png" alt="Search term using DQL toolbar in Dashboard" width="500">
 

diff --git 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 → _ingest-pipelines/create-ingest.md b/_api-reference/ingest-apis/create-ingest.md → _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 → _ingest-pipelines/delete-ingest.md b/_api-reference/ingest-apis/delete-ingest.md → _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 → _ingest-pipelines/get-ingest.md b/_api-reference/ingest-apis/get-ingest.md → _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/...reference/ingest-apis/ingest-pipelines.md → _ingest-pipelines/index.md b/...reference/ingest-apis/ingest-pipelines.md → _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/...eference/ingest-apis/pipeline-failures.md → _ingest-pipelines/pipeline-failures.md b/...eference/ingest-apis/pipeline-failures.md → _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/...eference/ingest-apis/processors/append.md → _ingest-pipelines/processors/append.md b/...eference/ingest-apis/processors/append.md → _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/...reference/ingest-apis/processors/bytes.md → _ingest-pipelines/processors/bytes.md b/...reference/ingest-apis/processors/bytes.md → _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/...ference/ingest-apis/processors/convert.md → _ingest-pipelines/processors/convert.md b/...ference/ingest-apis/processors/convert.md → _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 → _ingest-pipelines/processors/csv.md b/_api-reference/ingest-apis/processors/csv.md → _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/...-reference/ingest-apis/processors/date.md → _ingest-pipelines/processors/date.md b/...-reference/ingest-apis/processors/date.md → _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/...eference/ingest-apis/ingest-processors.md → ...-pipelines/processors/index-processors.md b/...eference/ingest-apis/ingest-processors.md → ...-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/...eference/ingest-apis/processors/ip2geo.md → _ingest-pipelines/processors/ip2geo.md b/...eference/ingest-apis/processors/ip2geo.md → _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/...rence/ingest-apis/processors/lowercase.md → _ingest-pipelines/processors/lowercase.md b/...rence/ingest-apis/processors/lowercase.md → _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/...eference/ingest-apis/processors/remove.md → _ingest-pipelines/processors/remove.md b/...eference/ingest-apis/processors/remove.md → _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/...ingest-apis/processors/sparse-encoding.md → ...t-pipelines/processors/sparse-encoding.md b/...ingest-apis/processors/sparse-encoding.md → ...t-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/.../ingest-apis/processors/text-embedding.md → ...st-pipelines/processors/text-embedding.md b/.../ingest-apis/processors/text-embedding.md → ...st-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/...t-apis/processors/text-image-embedding.md → ...elines/processors/text-image-embedding.md b/...t-apis/processors/text-image-embedding.md → ...elines/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/...rence/ingest-apis/processors/uppercase.md → _ingest-pipelines/processors/uppercase.md b/...rence/ingest-apis/processors/uppercase.md → _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/...-reference/ingest-apis/simulate-ingest.md → _ingest-pipelines/simulate-ingest.md b/...-reference/ingest-apis/simulate-ingest.md → _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