Propagate UI changes to 2.0 (#6063)

Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-project · Jan 8, 2024 · 0e1341d · 0e1341d
1 parent b663821
commit 0e1341d
Show file tree

Hide file tree

Showing 36 changed files with 520 additions and 167 deletions.
diff --git a/breaking-changes.md → _about/breaking-changes.md b/breaking-changes.md → _about/breaking-changes.md
@@ -2,7 +2,6 @@
 layout: default
 title: Breaking changes
 nav_order: 5
-parent: OpenSearch documentation
 permalink: /breaking-changes/
 ---
 

diff --git a/_about/index.md b/_about/index.md
@@ -0,0 +1,76 @@
+---
+layout: default
+title: Getting started
+nav_order: 1
+has_children: false
+has_toc: false
+permalink: /about/
+redirect_from:
+  - /docs/opensearch/
+  - /opensearch/
+  - /opensearch/index/
+---
+
+{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
+
+# OpenSearch and OpenSearch Dashboards
+
+This section contains documentation for OpenSearch and OpenSearch Dashboards.
+
+## Getting started
+
+- [Intro to OpenSearch]({{site.url}}{{site.baseurl}}/intro/)
+- [Quickstart]({{site.url}}{{site.baseurl}}/quickstart/)
+- [Install OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/)
+- [Install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/)
+- [See the FAQ](https://opensearch.org/faq)
+
+## Why use OpenSearch?
+
+With OpenSearch, you can perform the following use cases:
+
+<table style="table-layout: auto ; width: 100%;">
+<tbody>
+<tr style="text-align: left; vertical-align:top; font-weight: bold; color: rgb(0,59,92)">
+<td>Fast, Scalable Full-text Search</td>
+<td>Application and Infrastructure Monitoring</td>
+<td>Security and Event Information Management</td>
+<td>Operational Health Tracking</td>
+</tr>
+<tr style="text-align: left; vertical-align:top;">
+<td>Help users find the right information within your application, website, or data lake catalog. </td>
+<td>Easily store and analyze log data, and set automated alerts for underperformance.</td>
+<td>Centralize logs to enable real-time security monitoring and forensic analysis.</td>
+<td>Use observability logs, metrics, and traces to monitor your applications and business in real time.</td>
+</tr>
+</tbody>
+</table>
+
+**Additional features and plugins:**
+
+OpenSearch has several features and plugins to help index, secure, monitor, and analyze your data. Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
+- [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) - Identify atypical data and receive automatic notifications
+- [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) - Find “nearest neighbors” in your vector data
+- [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) - Monitor and optimize your cluster
+- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) - Use SQL or a piped processing language to query your data
+- [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) - Automate index operations
+- [ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) - Train and execute machine-learning models
+- [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) - Run search requests in the background
+- [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) - Replicate your data across multiple OpenSearch clusters
+
+
+## The secure path forward
+OpenSearch includes a demo configuration so that you can get up and running quickly, but before using OpenSearch in a production environment, you must [configure the Security plugin manually]({{site.url}}{{site.baseurl}}/security/configuration/index/) with your own certificates, authentication method, users, and passwords.
+
+## Looking for the Javadoc?
+
+See [opensearch.org/javadocs/](https://opensearch.org/javadocs/).
+
+## Get involved
+
+[OpenSearch](https://opensearch.org) is supported by Amazon Web Services. All components are available under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) on [GitHub](https://github.com/opensearch-project/).
+The project welcomes GitHub issues, bug fixes, features, plugins, documentation---anything at all. To get involved, see [Contributing](https://opensearch.org/source.html) on the OpenSearch website.
+
+---
+
+<small>OpenSearch includes certain Apache-licensed Elasticsearch code from Elasticsearch B.V. and other source code. Elasticsearch B.V. is not the source of that other source code. ELASTICSEARCH is a registered trademark of Elasticsearch B.V.</small>
diff --git a/about.md → _about/intro.md b/about.md → _about/intro.md
@@ -1,16 +1,10 @@
 ---
 layout: default
-title: About OpenSearch
+title: Intro to OpenSearch
 nav_order: 2
-parent: OpenSearch documentation
-redirect_from:
-  - /docs/opensearch/
-  - /opensearch/
-  - /opensearch/index/
+permalink: /intro/
 ---
 
-{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
-
 # Introduction to OpenSearch
 
 OpenSearch is a distributed search and analytics engine based on [Apache Lucene](https://lucene.apache.org/). After adding your data to OpenSearch, you can perform full-text searches on it with all of the features you might expect: search by field, search multiple indices, boost fields, rank results by score, sort results by field, and aggregate results.
@@ -83,13 +77,13 @@ PUT https://<host>:<port>/<index-name>/_doc/<document-id>
 
 To run a search for the document:
 
-```
+```json
 GET https://<host>:<port>/<index-name>/_search?q=wind
 ```
 
 To delete the document:
 
-```
+```json
 DELETE https://<host>:<port>/<index-name>/_doc/<document-id>
 ```
 

diff --git a/quickstart.md → _about/quickstart.md b/quickstart.md → _about/quickstart.md
@@ -1,8 +1,8 @@
 ---
 layout: default
 title: Quickstart
-parent: OpenSearch documentation
 nav_order: 3
+permalink: /quickstart/
 redirect_from: 
   - /opensearch/install/quickstart/
 ---

diff --git a/version-history.md → _about/version-history.md b/version-history.md → _about/version-history.md
@@ -2,7 +2,6 @@
 layout: default
 title: Version history
 nav_order: 4
-parent: OpenSearch documentation
 permalink: /version-history/
 ---
 

diff --git a/_clients/OSC-dot-net.md b/_clients/OSC-dot-net.md
@@ -4,6 +4,8 @@ title: Getting started with the high-level .NET client
 nav_order: 10
 has_children: false
 parent: .NET clients
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/OSC-dot-net/
 ---
 
 # Getting started with the high-level .NET client (OpenSearch.Client)

diff --git a/_clients/OSC-example.md b/_clients/OSC-example.md
@@ -4,6 +4,8 @@ title: More advanced features of the high-level .NET client
 nav_order: 12
 has_children: false
 parent: .NET clients
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/OSC-example/
 ---
 
 # More advanced features of the high-level .NET client (OpenSearch.Client)

diff --git a/_clients/OpenSearch-dot-net.md b/_clients/OpenSearch-dot-net.md
@@ -4,6 +4,8 @@ title: Low-level .NET client
 nav_order: 30
 has_children: false
 parent: .NET clients
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/OpenSearch-dot-net/
 ---
 
 # Low-level .NET client (OpenSearch.Net)

diff --git a/_clients/dot-net-conventions.md b/_clients/dot-net-conventions.md
@@ -4,6 +4,8 @@ title: .NET client considerations
 nav_order: 20
 has_children: false
 parent: .NET clients
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/dot-net-conventions/
 ---
 
 # .NET client considerations and best practices

diff --git a/_clients/dot-net.md b/_clients/dot-net.md
@@ -4,6 +4,8 @@ title: .NET clients
 nav_order: 75
 has_children: true
 has_toc: false
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/dot-net/
 ---
 
 # .NET clients

diff --git a/_clients/go.md b/_clients/go.md
@@ -2,6 +2,8 @@
 layout: default
 title: Go client
 nav_order: 80
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/go/
 ---
 
 # Go client

diff --git a/_clients/index.md b/_clients/index.md
@@ -5,6 +5,8 @@ nav_order: 1
 has_children: false
 redirect_from:
   - /clients/
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/
 ---
 
 # OpenSearch language clients

diff --git a/_clients/java-rest-high-level.md b/_clients/java-rest-high-level.md
@@ -2,6 +2,8 @@
 layout: default
 title: Java high-level REST client
 nav_order: 60
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/java-rest-high-level/
 ---
 
 # Java high-level REST client

diff --git a/_clients/java.md b/_clients/java.md
@@ -2,6 +2,8 @@
 layout: default
 title: Java client
 nav_order: 65
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/java/
 ---
 
 # Java client

diff --git a/_clients/javascript/helpers.md b/_clients/javascript/helpers.md
@@ -3,6 +3,8 @@ layout: default
 title: Helper methods
 parent: JavaScript client
 nav_order: 2
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/javascript/helpers/
 ---
 
 # Helper methods

diff --git a/_clients/javascript/index.md b/_clients/javascript/index.md
@@ -3,6 +3,8 @@ layout: default
 title: JavaScript client
 has_children: true
 nav_order: 40
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/javascript/index/
 ---
 
 # JavaScript client

diff --git a/_clients/php.md b/_clients/php.md
@@ -2,6 +2,8 @@
 layout: default
 title: PHP client
 nav_order: 90
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/php/
 ---
 
 # PHP client

diff --git a/_clients/python-high-level.md b/_clients/python-high-level.md
@@ -2,6 +2,8 @@
 layout: default
 title: High-level Python client
 nav_order: 5
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/python-high-level/
 ---
 
 The OpenSearch high-level Python client (`opensearch-dsl-py`) will be deprecated after version 2.1.0. We recommend switching to the [Python client (`opensearch-py`)]({{site.url}}{{site.baseurl}}/clients/python-low-level/), which now includes the functionality of `opensearch-dsl-py`.

diff --git a/_clients/python-low-level.md b/_clients/python-low-level.md
@@ -2,6 +2,8 @@
 layout: default
 title: Low-level Python client
 nav_order: 10
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/python-low-level/
 ---
 
 # Low-level Python client

diff --git a/_clients/ruby.md b/_clients/ruby.md
@@ -3,6 +3,8 @@ layout: default
 title: Ruby client
 nav_order: 77
 has_children: false
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/ruby/
 ---
 
 # Ruby client

diff --git a/_clients/rust.md b/_clients/rust.md
@@ -2,6 +2,8 @@
 layout: default
 title: Rust client
 nav_order: 100
+nav_exclude: true
+redirect_to: https://opensearch.org/docs/latest/clients/rust/
 ---
 
 # Rust client

diff --git a/_config.yml b/_config.yml
@@ -1,4 +1,4 @@
-title: OpenSearch documentation
+title: OpenSearch Documentation
 description: >- # this means to ignore newlines until "baseurl:"
   Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
 baseurl: "/docs/latest" # the subpath of your site, e.g. /blog
@@ -82,10 +82,16 @@ collections:
   external_links:
     permalink: /:collection/:path/
     output: true
+  about:
+    permalink: /:collection/:path/
+    output: true
 
-just_the_docs:
+opensearch_collection:
   # Define the collections used in the theme
   collections:
+    about:
+      name: About OpenSearch
+      nav_fold: true
     install-and-configure:
       name: Install and upgrade
       nav_fold: true
@@ -125,10 +131,7 @@ just_the_docs:
       name: Job Scheduler plugin
       nav_fold: true
     clients:
-      name: Clients and tools
-      nav_fold: true
-    data-prepper: 
-      name: Data Prepper
+      name: Tools
       nav_fold: true
     api-reference:
       name: API reference
@@ -139,6 +142,51 @@ just_the_docs:
     external_links:
       name: External links
 
+clients_collection:
+  collections:
+    clients:
+        name: Clients
+        nav_fold: true
+
+benchmark_collection:
+  collections:
+    benchmark:
+      name: OpenSearch Benchmark
+      nav_fold: true
+
+data_prepper_collection:
+  collections:
+    data-prepper: 
+      name: Data Prepper
+      nav_fold: true
+
+# Defaults
+
+defaults:
+  -
+    scope:
+      path: "" # an empty string here means all files in the project
+    values:
+      section: "opensearch"
+      section-name: "OpenSearch and OpenSearch Dashboards"
+  -
+    scope:
+      path: "_data-prepper"
+    values:
+      section: "data-prepper"
+      section-name: "Data Prepper"
+  -
+    scope:
+      path: "_clients"
+    values:
+      section: "clients"
+      section-name: "Clients"
+  -
+    scope:
+      path: "_benchmark"
+    values:
+      section: "benchmark"
+      section-name: "Benchmark"
 
 # Enable or disable the site search
 # By default, just-the-docs enables its JSON file-based search. We also have an OpenSearch-driven search functionality.

diff --git a/_data/top_nav.yml b/_data/top_nav.yml
@@ -84,8 +84,26 @@ items:
         url: /community_projects
   -
     label: Documentation
-    fragment: docs
-    url: /docs/
+    fragments: 
+    - docs
+    - opensearch
+    - data-prepper
+    - clients
+    - benchmark
+    url: /docs/latest/
+    children:
+      -
+        label: OpenSearch and Dashboards
+        url: /docs/latest/about/
+      -
+        label: Data Prepper
+        url: /docs/latest/data-prepper/
+      -
+        label: Clients
+        url: /docs/latest/clients/
+      -
+        label: Benchmark
+        url: /docs/latest/benchmark/
   -
     label: Platform
     url: /platform/index.html