From a6627bebdd01addb20bdc60d1b0b22d5cf59986d Mon Sep 17 00:00:00 2001 From: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> Date: Mon, 8 Jan 2024 19:01:40 -0500 Subject: [PATCH] Propagate UI changes to 1.3 (#6065) Signed-off-by: Fanit Kolchina Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com> --- .../breaking-changes.md | 1 - _about/index.md | 77 ++++++++ about.md => _about/intro.md | 14 +- quickstart.md => _about/quickstart.md | 2 +- .../version-history.md | 1 - _aggregations/index.md | 2 + _analyzers/index.md | 2 + _api-reference/index.md | 2 + _clients/index.md | 3 +- _config.yml | 61 +++++- _data-prepper/index.md | 3 +- _data/top_nav.yml | 22 ++- _field-types/index.md | 1 + _im-plugin/index.md | 2 +- _im-plugin/ism/policies.md | 2 +- _includes/banner.html | 2 +- _includes/cards.html | 37 ++++ _install-and-configure/index.md | 3 + _layouts/default.html | 84 ++++++-- _layouts/home.html | 35 ++++ _ml-commons-plugin/index.md | 3 + _monitoring-your-cluster/index.md | 3 + _observing-your-data/index.md | 2 + _query-dsl/index.md | 3 +- _sass/_home.scss | 185 ++++++++++++++++++ _sass/color_schemes/opensearch.scss | 12 ++ _sass/custom/custom.scss | 94 +++------ _search-plugins/index.md | 3 + _search-plugins/knn/performance-tuning.md | 2 +- _security/index.md | 3 +- _tools/index.md | 1 + _troubleshoot/index.md | 4 +- .../availability-and-recovery/index.md | 4 +- _tuning-your-cluster/index.md | 2 + _upgrade-to/index.md | 3 +- index.md | 68 +------ 36 files changed, 560 insertions(+), 188 deletions(-) rename breaking-changes.md => _about/breaking-changes.md (97%) 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 97% rename from breaking-changes.md rename to _about/breaking-changes.md index fbc45d73df..cd8f2cdffd 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..999638a5f3 --- /dev/null +++ b/_about/index.md @@ -0,0 +1,77 @@ +--- +layout: default +title: Getting started +nav_order: 1 +has_children: false +has_toc: false +nav_exclude: true +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 9b81727bb9..9913b859d7 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 136c16041a..4cc7f8dfa3 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 7a8b42f396..3944912b43 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/_aggregations/index.md b/_aggregations/index.md index 6836a67946..1c43799a10 100644 --- 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 diff --git a/_analyzers/index.md b/_analyzers/index.md index ff7fb88094..6dc0ef0a8c 100644 --- 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 diff --git a/_api-reference/index.md b/_api-reference/index.md index cf779e230d..b9024626a4 100644 --- a/_api-reference/index.md +++ b/_api-reference/index.md @@ -4,8 +4,10 @@ title: REST API reference nav_order: 1 has_toc: true nav_exclude: true +permalink: /api-reference/ redirect_from: - /opensearch/rest-api/index/ + - /api-reference/index/ --- # REST API reference diff --git a/_clients/index.md b/_clients/index.md index bf13b160c8..28a06ad379 100644 --- 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 diff --git a/_config.yml b/_config.yml index ced5fb8076..9ed5ea0f7e 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 @@ -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 @@ -142,12 +148,6 @@ just_the_docs: field-types: name: Mappings and field types nav_fold: true - clients: - name: Clients - nav_fold: true - data-prepper: - name: Data Prepper - nav_fold: true tools: name: Tools nav_fold: true @@ -158,6 +158,51 @@ just_the_docs: name: Troubleshooting nav_fold: true +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-prepper/index.md b/_data-prepper/index.md index fdd689cc04..36478568af 100644 --- 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 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/_field-types/index.md b/_field-types/index.md index 27ef3ad448..5ee0037729 100644 --- a/_field-types/index.md +++ b/_field-types/index.md @@ -3,6 +3,7 @@ layout: default title: Mappings and field types nav_order: 1 nav_exclude: true +permalink: /field-types/ redirect_from: - /opensearch/mappings/ --- diff --git a/_im-plugin/index.md b/_im-plugin/index.md index f8a6aef2b4..b1470a24aa 100644 --- a/_im-plugin/index.md +++ b/_im-plugin/index.md @@ -4,8 +4,8 @@ title: Managing indexes nav_order: 1 has_children: false nav_exclude: true +permalink: /im-plugin/ redirect_from: - - /im-plugin/ - /opensearch/index-data/ --- diff --git a/_im-plugin/ism/policies.md b/_im-plugin/ism/policies.md index 48ae6c6fe0..896a65e059 100644 --- a/_im-plugin/ism/policies.md +++ b/_im-plugin/ism/policies.md @@ -162,7 +162,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 @@
-