Skip to content

Commit ba56c07

Browse files
authored
Refactor OpenSearch/Dashboards front page (opensearch-project#8114)
* Refactor OpenSearch/Dashboards front page Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Editorial comments Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
1 parent 19eacb8 commit ba56c07

File tree

4 files changed

+49
-34
lines changed

4 files changed

+49
-34
lines changed

_about/index.md

+30-22
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,21 @@ This section contains documentation for OpenSearch and OpenSearch Dashboards.
2222

2323
## Getting started
2424

25-
- [Intro to OpenSearch]({{site.url}}{{site.baseurl}}/intro/)
26-
- [Quickstart]({{site.url}}{{site.baseurl}}/quickstart/)
25+
To get started, explore the following documentation:
26+
27+
- [Getting started guide]({{site.url}}{{site.baseurl}}/getting-started/):
28+
- [Intro to OpenSearch]({{site.url}}{{site.baseurl}}/getting-started/intro/)
29+
- [Installation quickstart]({{site.url}}{{site.baseurl}}/getting-started/quickstart/)
30+
- [Communicate with OpenSearch]({{site.url}}{{site.baseurl}}/getting-started/communicate/)
31+
- [Ingest data]({{site.url}}{{site.baseurl}}/getting-started/ingest-data/)
32+
- [Search data]({{site.url}}{{site.baseurl}}/getting-started/search-data/)
33+
- [Getting started with OpenSearch security]({{site.url}}{{site.baseurl}}/getting-started/security/)
2734
- [Install OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/)
2835
- [Install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/)
29-
- [See the FAQ](https://opensearch.org/faq)
36+
- [FAQ](https://opensearch.org/faq)
3037

3138
## Why use OpenSearch?
3239

33-
With OpenSearch, you can perform the following use cases:
34-
3540
<table style="table-layout: auto ; width: 100%;">
3641
<tbody>
3742
<tr style="text-align: center; vertical-align:center;">
@@ -41,35 +46,38 @@ With OpenSearch, you can perform the following use cases:
4146
<td><img src="{{site.url}}{{site.baseurl}}/images/4_tracking.png" class="no-border" alt="Operational health tracking" height="100"/></td>
4247
</tr>
4348
<tr style="text-align: left; vertical-align:top; font-weight: bold; color: rgb(0,59,92)">
44-
<td>Fast, Scalable Full-text Search</td>
45-
<td>Application and Infrastructure Monitoring</td>
46-
<td>Security and Event Information Management</td>
47-
<td>Operational Health Tracking</td>
49+
<td>Fast, scalable full-text search</td>
50+
<td>Application and infrastructure monitoring</td>
51+
<td>Security and event information management</td>
52+
<td>Operational health tracking</td>
4853
</tr>
4954
<tr style="text-align: left; vertical-align:top;">
5055
<td>Help users find the right information within your application, website, or data lake catalog. </td>
51-
<td>Easily store and analyze log data, and set automated alerts for underperformance.</td>
56+
<td>Easily store and analyze log data, and set automated alerts for performance issues.</td>
5257
<td>Centralize logs to enable real-time security monitoring and forensic analysis.</td>
53-
<td>Use observability logs, metrics, and traces to monitor your applications and business in real time.</td>
58+
<td>Use observability logs, metrics, and traces to monitor your applications in real time.</td>
5459
</tr>
5560
</tbody>
5661
</table>
5762

58-
**Additional features and plugins:**
63+
## Key features
64+
65+
OpenSearch provides several features to help index, secure, monitor, and analyze your data:
5966

60-
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.
61-
- [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) - Identify atypical data and receive automatic notifications
62-
- [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) - Find “nearest neighbors” in your vector data
63-
- [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) - Monitor and optimize your cluster
64-
- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) - Use SQL or a piped processing language to query your data
65-
- [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) - Automate index operations
66-
- [ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) - Train and execute machine-learning models
67-
- [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) - Run search requests in the background
68-
- [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) - Replicate your data across multiple OpenSearch clusters
67+
- [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) -- Identify atypical data and receive automatic notifications.
68+
- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) -- Use SQL or a Piped Processing Language (PPL) to query your data.
69+
- [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) -- Automate index operations.
70+
- [Search methods]({{site.url}}{{site.baseurl}}/search-plugins/knn/) -- From traditional lexical search to advanced vector and hybrid search, discover the optimal search method for your use case.
71+
- [Machine learning]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) -- Integrate machine learning models into your workloads.
72+
- [Workflow automation]({{site.url}}{{site.baseurl}}/automating-configurations/index/) -- Automate complex OpenSearch setup and preprocessing tasks.
73+
- [Performance evaluation]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) -- Monitor and optimize your cluster.
74+
- [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) -- Run search requests in the background.
75+
- [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) -- Replicate your data across multiple OpenSearch clusters.
6976

7077

7178
## The secure path forward
72-
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.
79+
80+
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. To get started, see [Getting started with OpenSearch security]({{site.url}}{{site.baseurl}}/getting-started/security/).
7381

7482
## Looking for the Javadoc?
7583

_getting-started/intro.md

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ ID | Name | GPA | Graduation year
5656
1 | John Doe | 3.89 | 2022
5757
2 | Jonathan Powers | 3.85 | 2025
5858
3 | Jane Doe | 3.52 | 2024
59+
... | | |
5960

6061
## Clusters and nodes
6162

_ml-commons-plugin/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ ML Commons supports various algorithms to help train ML models and make predicti
3232

3333
ML Commons provides its own set of REST APIs. For more information, see [ML Commons API]({{site.url}}{{site.baseurl}}/ml-commons-plugin/api/index/).
3434

35+
## ML-powered search
36+
37+
For information about available ML-powered search types, see [ML-powered search]({{site.url}}{{site.baseurl}}/search-plugins/index/#ml-powered-search).
38+
3539
## Tutorials
3640

3741
Using the OpenSearch ML framework, you can build various applications, from implementing conversational search to building your own chatbot. For more information, see [Tutorials]({{site.url}}{{site.baseurl}}/ml-commons-plugin/tutorials/index/).

_search-plugins/index.md

+14-12
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,31 @@ OpenSearch provides many features for customizing your search use cases and impr
1616

1717
## Search methods
1818

19-
OpenSearch supports the following search methods:
19+
OpenSearch supports the following search methods.
2020

21-
- **Traditional lexical search**
21+
### Traditional lexical search
2222

23-
- [Keyword (BM25) search]({{site.url}}{{site.baseurl}}/search-plugins/keyword-search/): Searches the document corpus for words that appear in the query.
23+
OpenSearch supports [keyword (BM25) search]({{site.url}}{{site.baseurl}}/search-plugins/keyword-search/), which searches the document corpus for words that appear in the query.
2424

25-
- **Machine learning (ML)-powered search**
25+
### ML-powered search
2626

27-
- **Vector search**
27+
OpenSearch supports the following machine learning (ML)-powered search methods:
2828

29-
- [k-NN search]({{site.url}}{{site.baseurl}}/search-plugins/knn/): Searches for k-nearest neighbors to a search term across an index of vectors.
29+
- **Vector search**
3030

31-
- **Neural search**: [Neural search]({{site.url}}{{site.baseurl}}/search-plugins/neural-search/) facilitates generating vector embeddings at ingestion time and searching them at search time. Neural search lets you integrate ML models into your search and serves as a framework for implementing other search methods. The following search methods are built on top of neural search:
31+
- [k-NN search]({{site.url}}{{site.baseurl}}/search-plugins/knn/): Searches for the k-nearest neighbors to a search term across an index of vectors.
3232

33-
- [Semantic search]({{site.url}}{{site.baseurl}}/search-plugins/semantic-search/): Considers the meaning of the words in the search context. Uses dense retrieval based on text embedding models to search text data.
33+
- **Neural search**: [Neural search]({{site.url}}{{site.baseurl}}/search-plugins/neural-search/) facilitates generating vector embeddings at ingestion time and searching them at search time. Neural search lets you integrate ML models into your search and serves as a framework for implementing other search methods. The following search methods are built on top of neural search:
3434

35-
- [Multimodal search]({{site.url}}{{site.baseurl}}/search-plugins/multimodal-search/): Uses multimodal embedding models to search text and image data.
35+
- [Semantic search]({{site.url}}{{site.baseurl}}/search-plugins/semantic-search/): Considers the meaning of the words in the search context. Uses dense retrieval based on text embedding models to search text data.
3636

37-
- [Neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/): Uses sparse retrieval based on sparse embedding models to search text data.
37+
- [Multimodal search]({{site.url}}{{site.baseurl}}/search-plugins/multimodal-search/): Uses multimodal embedding models to search text and image data.
3838

39-
- [Hybrid search]({{site.url}}{{site.baseurl}}/search-plugins/hybrid-search/): Combines traditional search and vector search to improve search relevance.
39+
- [Neural sparse search]({{site.url}}{{site.baseurl}}/search-plugins/neural-sparse-search/): Uses sparse retrieval based on sparse embedding models to search text data.
4040

41-
- [Conversational search]({{site.url}}{{site.baseurl}}/search-plugins/conversational-search/): Implements a retrieval-augmented generative search.
41+
- [Hybrid search]({{site.url}}{{site.baseurl}}/search-plugins/hybrid-search/): Combines traditional search and vector search to improve search relevance.
42+
43+
- [Conversational search]({{site.url}}{{site.baseurl}}/search-plugins/conversational-search/): Implements a retrieval-augmented generative search.
4244

4345
## Query languages
4446

0 commit comments

Comments
 (0)