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..a05387a15a --- /dev/null +++ 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: + + + + + + + + + + + + + + + + + + + + + + +
Fast, scalable full-text searchApplication and infrastructure monitoringSecurity and event information managementOperational health tracking
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 836b19f139..7194ed9afe 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/_config.yml b/_config.yml index e2d8029615..fd8b661a73 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 @@ -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 index 73e9db7d2a..70ddbaeb55 100644 --- 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 index 02a14d8df4..d15cac8948 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 @@
-