Propagate UI changes to 2.3 (#6060)

Signed-off-by: Fanit Kolchina <[email protected]>
opensearch-project · Jan 8, 2024 · 4173de3 · 4173de3
1 parent 4576f63
commit 4173de3
Show file tree

Hide file tree

Showing 20 changed files with 493 additions and 173 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,82 @@
+---
+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: center; vertical-align:center;">
+<td><img src="{{site.url}}{{site.baseurl}}/images/1_search.png" class="no-border" alt="Fast, scalable full-text search" height="100"/></td>
+<td><img src="{{site.url}}{{site.baseurl}}/images/2_monitoring.png" class="no-border" alt="Application and infrastructure monitoring" height="100"/></td>
+<td><img src="{{site.url}}{{site.baseurl}}/images/3_security.png" class="no-border" alt="Security and event information management" height="100"/></td>
+<td><img src="{{site.url}}{{site.baseurl}}/images/4_tracking.png" class="no-border" alt="Operational health tracking" height="100"/></td>
+</tr>
+<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/_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
@@ -88,10 +88,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
@@ -130,12 +136,6 @@ just_the_docs:
     observing-your-data:
       name: Observability
       nav_fold: true
-    clients:
-      name: Clients
-      nav_fold: true
-    data-prepper: 
-      name: Data Prepper
-      nav_fold: true
     tools:
       name: Tools
       nav_fold: true
@@ -148,6 +148,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
@@ -80,8 +80,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

diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md
@@ -164,7 +164,7 @@ Parameter | Description | Type | Required
 }
 ```
 
-For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/opensearch#primary-and-replica-shards).
+For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/intro/#primary-and-replica-shards).
 
 ### shrink
 

diff --git a/_includes/banner.html b/_includes/banner.html
@@ -1,5 +1,5 @@
 <section class="os-banner">
-    <header class="banner-head" style="background-image: url('{{site.url}}{{site.baseurl}}/images/graphic-bg.png')">
+    <header class="banner-head">
         <div class="banner-text-div">
             <span class="banner-text-header">OpenSearch Documentation</span>
             <p class="banner-text-description">Learn to use OpenSearch, the highly scalable and extensible open-source software suite for search, analytics, observability, and other data-intensive applications.</p>

diff --git a/_includes/cards.html b/_includes/cards.html
@@ -0,0 +1,37 @@
+<div class="card-container-wrapper">
+  <p class="heading-main">Explore OpenSearch documentation</p>
+  <div class="card-container">
+    <div class="card">
+      <a href="{{site.url}}{{site.baseurl}}/about/" class='card-link'></a>
+        <p class="heading">OpenSearch and OpenSearch Dashboards</p>
+        <p class="description">Learn how to power up your search</p>
+        <button class="last-link">Documentation &#x2192;</button>
+      </div>
+
+
+    <div class="card">
+      <a href="http://opensearch.org/docs/latest/data-prepper/" class='card-link'></a>
+        <p class="heading">Data Prepper</p>
+        <p class="description">Prepare your data for OpenSearch</p>
+        <button class="last-link" >Documentation &#x2192;</button>
+      </div>
+
+    <div class="card">
+      <a href="http://opensearch.org/docs/latest/clients/" class='card-link'></a>
+        <p class="heading">Clients</p>
+        <p class="description">OpenSearch in your programming language</p>
+        <button class="last-link">Documentation &#x2192;</button>
+      </div>
+
+
+    <div class="card">
+      <a href="http://opensearch.org/docs/latest/benchmark/" class='card-link'></a>
+        <p class="heading">Benchmark</p>
+        <p class="description">Track OpenSearch performance</p>
+        <button class="last-link">Documentation &#x2192;</button>
+      </div>  
+  </div>
+
+</div>
+
+
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -56,10 +56,20 @@
           Documentation <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-grid"></use></svg>
         </a>
       </div>
-      <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
+      <nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">        
         <div class="version-wrapper">
-          <version-selector selected="{{ site.data.versions.current }}"></version-selector>
-        </div>
+          {% if page.section == "opensearch" %}
+            <a href="{{site.url}}{{site.baseurl}}/about/" class="site-category">{{ page.section-name }}</a>
+          {% else %}
+            <a href="{{site.url}}{{site.baseurl}}/{{ page.section}}/" class="site-category">{{ page.section-name }}</a>
+          {% endif %}
+
+          <a href="{{site.url}}/docs/latest/" class="back-link">&#x2190; Back to docs home</a>
+
+          {% if page.section == "opensearch" %}
+            <version-selector selected="{{ site.data.versions.current }}"></version-selector>
+          {% endif %}
+          </div>
         {% assign pages_top_size = site.html_pages
             | where_exp:"item", "item.title != nil"
             | where_exp:"item", "item.parent == nil"
@@ -68,9 +78,20 @@
         {% if pages_top_size > 0 %}
           {% include nav.html pages=site.html_pages key=nil %}
         {% endif %}
-        {% if site.just_the_docs.collections %}
-          {% assign collections_size = site.just_the_docs.collections | size %}
-          {% for collection_entry in site.just_the_docs.collections %}
+
+        {% if page.section == "opensearch" %}
+          {% assign section = site.opensearch_collection.collections %}
+        {% elsif page.section == "data-prepper" %}
+          {% assign section = site.data_prepper_collection.collections %}
+        {% elsif page.section == "clients" %}
+          {% assign section = site.clients_collection.collections %}
+        {% elsif page.section == "benchmark" %}
+          {% assign section = site.benchmark_collection.collections %}
+        {% endif %}
+
+        {% if section %}
+          {% assign collections_size = section | size %}
+          {% for collection_entry in section %}
             {% assign collection_key = collection_entry[0] %}
             {% assign collection_value = collection_entry[1] %}
             {% assign collection = site[collection_key] %}
@@ -179,7 +200,7 @@ <h2>Related articles</h2>
       <div class="toc-wrap">
         <div class="sticky-wrap">
           <div class="toc">
-            {% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
+            {% include toc.html html=content h_min=2 h_max=3 class="toc-list" item_class="toc-item" sanitize=true %}
           </div>
           {% include feedback.html %}
         </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -164,7 +164,7 @@ Parameter | Description | Type | Required @@
     }
     ```
-    For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/opensearch#primary-and-replica-shards).
+    For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/intro/#primary-and-replica-shards).
     ### shrink
@@ Expand Down @@