From 0e1341d973b841cf2fe1693cf019c99e4d9418fe Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Mon, 8 Jan 2024 16:54:54 -0500 Subject: [PATCH] Propagate UI changes to 2.0 (#6063) Signed-off-by: Fanit Kolchina --- .../breaking-changes.md | 1 - _about/index.md | 76 +++++++ about.md => _about/intro.md | 14 +- quickstart.md => _about/quickstart.md | 2 +- .../version-history.md | 1 - _clients/OSC-dot-net.md | 2 + _clients/OSC-example.md | 2 + _clients/OpenSearch-dot-net.md | 2 + _clients/dot-net-conventions.md | 2 + _clients/dot-net.md | 2 + _clients/go.md | 2 + _clients/index.md | 2 + _clients/java-rest-high-level.md | 2 + _clients/java.md | 2 + _clients/javascript/helpers.md | 2 + _clients/javascript/index.md | 2 + _clients/php.md | 2 + _clients/python-high-level.md | 2 + _clients/python-low-level.md | 2 + _clients/ruby.md | 2 + _clients/rust.md | 2 + _config.yml | 60 +++++- _data/top_nav.yml | 22 ++- _im-plugin/ism/policies.md | 2 +- _includes/banner.html | 2 +- _includes/cards.html | 37 ++++ _layouts/default.html | 35 +++- _layouts/home.html | 35 ++++ _observing-your-data/index.md | 1 + _sass/_home.scss | 185 ++++++++++++++++++ _sass/color_schemes/opensearch.scss | 12 ++ _sass/custom/custom.scss | 95 +++------ _search-plugins/knn/performance-tuning.md | 2 +- .../availability-and-recovery/index.md | 4 +- _upgrade-to/index.md | 2 +- index.md | 67 +------ 36 files changed, 520 insertions(+), 167 deletions(-) rename breaking-changes.md => _about/breaking-changes.md (98%) create mode 100644 _about/index.md rename about.md => _about/intro.md (94%) rename quickstart.md => _about/quickstart.md (99%) rename version-history.md => _about/version-history.md (99%) create mode 100644 _includes/cards.html create mode 100644 _layouts/home.html create mode 100644 _sass/_home.scss diff --git a/breaking-changes.md b/_about/breaking-changes.md similarity index 98% rename from breaking-changes.md rename to _about/breaking-changes.md index fde3e546c7..406da05233 100644 --- a/breaking-changes.md +++ b/_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 new file mode 100644 index 0000000000..6bdbeaf171 --- /dev/null +++ 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: + + + + + + + + + + + + + + + + +
Fast, Scalable Full-text SearchApplication and Infrastructure MonitoringSecurity and Event Information ManagementOperational Health Tracking
Help users find the right information within your application, website, or data lake catalog. Easily store and analyze log data, and set automated alerts for underperformance.Centralize logs to enable real-time security monitoring and forensic analysis.Use observability logs, metrics, and traces to monitor your applications and business in real time.
+ +**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. + +--- + +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. \ No newline at end of file diff --git a/about.md b/_about/intro.md similarity index 94% rename from about.md rename to _about/intro.md index ae766f14a4..1c8e01bc78 100644 --- a/about.md +++ b/_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://://_doc/ To run a search for the document: -``` +```json GET https://://_search?q=wind ``` To delete the document: -``` +```json DELETE https://://_doc/ ``` diff --git a/quickstart.md b/_about/quickstart.md similarity index 99% rename from quickstart.md rename to _about/quickstart.md index 5b2c9a7b36..351c730f29 100644 --- a/quickstart.md +++ b/_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 b/_about/version-history.md similarity index 99% rename from version-history.md rename to _about/version-history.md index ad5774c621..a92bb02b6e 100644 --- a/version-history.md +++ b/_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 index 98a0b8e8fe..ee6089d197 100644 --- 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 index 4511e2b45e..9cef83e57d 100644 --- 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 index df8f7b06ae..2c7e7a5ffb 100644 --- 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 index a0ee02953f..3795fca0c2 100644 --- 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 index 8e212e0e7f..63779421d9 100644 --- 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 index 657bc342ec..f9c11ae7f6 100644 --- 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 index 6c6cc92035..200a0d92ed 100644 --- 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 index abe6cbda27..8b31a1537a 100644 --- 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 index a4e0dda8a2..0b2c604a47 100644 --- 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 index 9efd74d305..0f24e200a6 100644 --- 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 index 6f4d693eee..9ebd0f911b 100644 --- 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 index 6a6cbe29d6..1b4596eaed 100644 --- 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 index ff529eb0cd..5c11874269 100644 --- 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 index 14919a8e82..369d963121 100644 --- 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 index 272486847d..3d248ee7a8 100644 --- 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 index 36d1d24d23..0b2f81a14c 100644 --- 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 index 3953f23273..beba469313 100644 --- 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 index 0515ae3f49..b02c06328b 100644 --- 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 diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 5d9f127ac8..166448d79b 100644 --- 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 index f9ee474054..dadf93f578 100644 --- a/_includes/banner.html +++ b/_includes/banner.html @@ -1,5 +1,5 @@
-