Change navigation for index pages of collections (#6039)

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
2024-01-04 14:55:05 -05:00 · 2024-01-04 14:55:05 -05:00 · 699cb9ac20
parent dc41f059f5
commit 699cb9ac20
27 changed files with 73 additions and 10 deletions
--- a/_aggregations/index.md
+++ b/_aggregations/index.md
@ -4,9 +4,11 @@ title: Aggregations
 has_children: true
 nav_order: 5
 nav_exclude: true
+permalink: /aggregations/
 redirect_from:
  - /opensearch/aggregations/
  - /query-dsl/aggregations/
+  - /aggregations/index/
 ---

 # Aggregations
--- a/_analyzers/index.md
+++ b/_analyzers/index.md
@ -5,10 +5,12 @@ has_children: true
 nav_order: 5
 nav_exclude: true
 has_toc: false
+permalink: /analyzers/
 redirect_from: 
  - /opensearch/query-dsl/text-analyzers/
  - /query-dsl/analyzers/text-analyzers/
  - /analyzers/text-analyzers/
+  - /analyzers/index/
 ---

 # Text analysis
--- a/_api-reference/index.md
+++ b/_api-reference/index.md
@ -5,8 +5,10 @@ nav_order: 1
 has_toc: false
 has_children: true
 nav_exclude: true
+permalink: /api-reference/
 redirect_from:
  - /opensearch/rest-api/index/
+  - /api-reference/index/
 ---

 # REST API reference
--- a/_benchmark/index.md
+++ b/_benchmark/index.md
@ -5,8 +5,9 @@ nav_order: 1
 has_children: false
 nav_exclude: true
 has_toc: false
+permalink: /benchmark/
 redirect_from:
-  - /benchmark/
+  - /benchmark/index/
 ---

 # OpenSearch Benchmark
--- a/_clients/index.md
+++ b/_clients/index.md
@ -4,8 +4,9 @@ title: Language clients
 nav_order: 1
 has_children: false
 nav_exclude: true
+permalink: /clients/
 redirect_from:
-  - /clients/
+  - /clients/index/
 ---

 # OpenSearch language clients
--- a/_dashboards/index.md
+++ b/_dashboards/index.md
@ -4,6 +4,9 @@ title: OpenSearch Dashboards
 nav_order: 1
 has_children: false
 nav_exclude: true
+permalink: /dashboards/
+redirect_from:
+  - /dashboards/index/
 ---

 # OpenSearch Dashboards
--- a/_data-prepper/index.md
+++ b/_data-prepper/index.md
@ -5,10 +5,11 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /data-prepper/
 redirect_from: 
  - /clients/data-prepper/index/
-  - /data-prepper/
  - /monitoring-plugins/trace/data-prepper/
+  - /data-prepper/index/
 ---

 # Data Prepper
--- a/_developer-documentation/index.md
+++ b/_developer-documentation/index.md
@ -5,6 +5,9 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /developer-documentation/
+redirect_from:
+  - /developer-documentation/index/
 ---

 # Developer documentation
--- a/_field-types/index.md
+++ b/_field-types/index.md
@ -3,9 +3,11 @@ layout: default
 title: Mappings and field types
 nav_order: 1
 nav_exclude: true
+permalink: /field-types/
 redirect_from: 
  - /opensearch/mappings/
  - /field-types/mappings/
+  - /field-types/index/
 ---

 # Mappings and field types
--- a/_im-plugin/index.md
+++ b/_im-plugin/index.md
@ -4,10 +4,14 @@ title: Managing indexes
 nav_order: 1
 has_children: false
 nav_exclude: true
+permalink: /index-management/
 redirect_from:
  - /im-plugin/
  - /opensearch/index-data/
  - /opensearch/rest-api/index-apis/index/
+  - /index-management/index/
+  - /im-plugin/index/
+  - /index-management/
 ---

 # Managing indexes
--- a/_ingest-pipelines/index.md
+++ b/_ingest-pipelines/index.md
@ -3,8 +3,10 @@ layout: default
 title: Ingest pipelines
 nav_order: 5
 nav_exclude: true
+permalink: /ingest-pipelines/
 redirect_from:
   - /api-reference/ingest-apis/ingest-pipelines/
+   - /ingest-pipelines/index/
 ---

 # Ingest pipelines
--- a/_install-and-configure/index.md
+++ b/_install-and-configure/index.md
@ -5,6 +5,9 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /install-and-configure/
+redirect_from:
+  - /install-and-configure/index/
 ---

 # Install and upgrade OpenSearch
--- a/_integrations/index.md
+++ b/_integrations/index.md
@ -4,6 +4,9 @@ title: OpenSearch Integrations
 nav_order: 1
 has_children: false
 nav_exclude: true
+permalink: /integrations/
+redirect_from:
+  - /integrations/index/
 ---

 # OpenSearch Integrations
--- a/_layouts/default.html
+++ b/_layouts/default.html
@ -105,7 +105,7 @@ layout: table_wrappers
                  >
                    <li role="none" class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
                      
-                      {% assign collection_url_path = collection_key | append: "/index/" %}
+                      {% assign collection_url_path = collection_key | append: "/" %}
                      {% assign category_comparison_url = "/" | append: collection_url_path %}
                      {%- if collection.size > 0 -%}
                        <a 
@ -127,7 +127,7 @@ layout: table_wrappers
                    </li>
                  </ul>
                {% else %}
-                  {% assign collection_url_path = collection_key | append: "/index/" %}
+                  {% assign collection_url_path = collection_key | append: "/" %}
                  <a 
                    role="treeitem"
                    aria-owns="{{ owned_tree_id }}"
--- a/_ml-commons-plugin/index.md
+++ b/_ml-commons-plugin/index.md
@ -5,6 +5,12 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /machine-learning/
+redirect_from: 
+  - /ml-commons-plugin/
+  - /ml-commons-plugin/index/
+  - /machine-learning/index/
+  - /machine-learning/
 ---

 # Machine learning
--- a/_monitoring-your-cluster/index.md
+++ b/_monitoring-your-cluster/index.md
@ -5,6 +5,9 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /monitoring-your-cluster/
+redirect_from: 
+  - /monitoring-your-cluster/index/
 ---

 # Monitoring your cluster
--- a/_observing-your-data/index.md
+++ b/_observing-your-data/index.md
@ -4,8 +4,13 @@ title: Observability
 nav_order: 1
 has_children: true
 nav_exclude: true
+permalink: /observability/
 redirect_from:
  - /observability-plugin/index/
+  - /observing-your-data/
+  - /observing-your-data/index/
+  - /observability/index/
+  - /observability/
 ---

 # Observability
--- a/_query-dsl/index.md
+++ b/_query-dsl/index.md
@ -5,12 +5,13 @@ nav_order: 2
 has_children: true
 nav_exclude: true
 has_toc: false
+permalink: /query-dsl/
 redirect_from:
  - /opensearch/query-dsl/
  - /opensearch/query-dsl/index/
  - /docs/opensearch/query-dsl/
  - /query-dsl/query-dsl/
-  - /query-dsl/
+  - /query-dsl/index/
 ---

 {%- comment -%}The `/docs/opensearch/query-dsl/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
--- a/_reporting/index.md
+++ b/_reporting/index.md
@ -4,6 +4,9 @@ title: Reporting
 nav_order: 1
 has_children: false
 nav_exclude: true
+permalink: /reporting/
+redirect_from:
+  - /reporting/index/
 ---

 # Reporting
--- a/_search-plugins/index.md
+++ b/_search-plugins/index.md
@ -5,6 +5,12 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /search/
+redirect_from:
+  - /search-plugins/
+  - /search-plugins/index/
+  - /search/index/
+  - /search/
 ---

 # Search
--- a/_security-analytics/index.md
+++ b/_security-analytics/index.md
@ -5,8 +5,9 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /security-analytics/
 redirect_from:
-  - /security-analytics/
+  - /security-analytics/index/
 ---


--- a/_security/index.md
+++ b/_security/index.md
@ -5,10 +5,11 @@ nav_order: 1
 has_children: false
 has_toc: false
 nav_exclude: true
+permalink: /security/
 redirect_from:
  - /security-plugin/
  - /security-plugin/index/
-  - /security/
+  - /security/index/
 ---

 # About Security in OpenSearch
--- a/_tools/index.md
+++ b/_tools/index.md
@ -4,8 +4,10 @@ title: Tools
 nav_order: 50
 has_children: false
 nav_exclude: true
+permalink: /tools/
 redirect_from:
  - /clients/agents-and-ingestion-tools/index/
+  - /tools/index/
 ---

 # OpenSearch tools
--- a/_troubleshoot/index.md
+++ b/_troubleshoot/index.md
@ -4,7 +4,9 @@ title: Common issues
 nav_order: 1
 has_toc: false
 nav_exclude: true
-redirect_from: /troubleshoot/
+permalink: /troubleshoot/
+redirect_from:
+  - /troubleshoot/index/
 ---

 # Common issues
--- a/_tuning-your-cluster/availability-and-recovery/index.md
+++ b/_tuning-your-cluster/availability-and-recovery/index.md
@ -4,6 +4,7 @@ title: Availability and recovery
 nav_order: 20
 has_children: true
 has_toc: true
+permalink: /tuning-your-cluster/
 ---

 # Availability and recovery
--- a/_tuning-your-cluster/index.md
+++ b/_tuning-your-cluster/index.md
@ -3,9 +3,11 @@ layout: default
 title: Creating a cluster
 nav_order: 1
 nav_exclude: true
+permalink: /tuning-your-cluster/
 redirect_from: 
  - /opensearch/cluster/
  - /tuning-your-cluster/cluster/
+  - /tuning-your-cluster/index/
 ---

 # Creating a cluster
--- a/_upgrade-to/index.md
+++ b/_upgrade-to/index.md
@ -3,8 +3,9 @@ layout: default
 title: About the migration process
 nav_order: 1
 nav_exclude: true
+permalink: /upgrade-to/
 redirect_from:
-  - /upgrade-to/
+  - /upgrade-to/index/
 ---

 # About the migration process