Skip to content

Commit ff06939

Browse files
kolchfa-awskolchfa-aws
authored
Separate clients, data prepper, and benchmark documentation (opensearch-project#5878)
* Separate clients, data prepper, and benchmark documentation Signed-off-by: Fanit Kolchina <[email protected]> * Flexbox card positioning Signed-off-by: Fanit Kolchina <[email protected]> * Change flex basis Signed-off-by: Fanit Kolchina <[email protected]> * Add links to home page Signed-off-by: Fanit Kolchina <[email protected]> * Change card layout to grid Signed-off-by: Fanit Kolchina <[email protected]> * Refactor section traversal Signed-off-by: Fanit Kolchina <[email protected]> * Add json formatting Signed-off-by: Fanit Kolchina <[email protected]> * Refactor home layout Signed-off-by: Fanit Kolchina <[email protected]> * Link the top left nav header to main page and add items to top menu Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Fanit Kolchina <[email protected]>
1 parent 9d613d4 commit ff06939

File tree

18 files changed

+490
-173
lines changed

18 files changed

+490
-173
lines changed

‎breaking-changes.md renamed to ‎_about/breaking-changes.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
layout: default
33
title: Breaking changes
44
nav_order: 5
5-
parent: OpenSearch documentation
65
permalink: /breaking-changes/
76
---
87

‎_about/index.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
---
2+
layout: default
3+
title: Getting started
4+
nav_order: 1
5+
has_children: false
6+
has_toc: false
7+
nav_exclude: true
8+
redirect_from:
9+
- /docs/opensearch/
10+
- /opensearch/
11+
- /opensearch/index/
12+
- /about/
13+
---
14+
15+
{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
16+
17+
# OpenSearch and OpenSearch Dashboards
18+
19+
This section contains documentation for OpenSearch and OpenSearch Dashboards.
20+
21+
## Getting started
22+
23+
- [Intro to OpenSearch]({{site.url}}{{site.baseurl}}/about/intro/)
24+
- [Quickstart]({{site.url}}{{site.baseurl}}/quickstart/)
25+
- [Install OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/)
26+
- [Install OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/index/)
27+
- [See the FAQ](https://opensearch.org/faq)
28+
29+
## Why use OpenSearch?
30+
31+
With OpenSearch, you can perform the following use cases:
32+
33+
<table style="table-layout: auto ; width: 100%;">
34+
<tbody>
35+
<tr style="text-align: center; vertical-align:center;">
36+
<td><img src="{{site.url}}{{site.baseurl}}/images/1_search.png" class="no-border" alt="Fast, scalable full-text search" height="100"/></td>
37+
<td><img src="{{site.url}}{{site.baseurl}}/images/2_monitoring.png" class="no-border" alt="Application and infrastructure monitoring" height="100"/></td>
38+
<td><img src="{{site.url}}{{site.baseurl}}/images/3_security.png" class="no-border" alt="Security and event information management" height="100"/></td>
39+
<td><img src="{{site.url}}{{site.baseurl}}/images/4_tracking.png" class="no-border" alt="Operational health tracking" height="100"/></td>
40+
</tr>
41+
<tr style="text-align: left; vertical-align:top; font-weight: bold; color: rgb(0,59,92)">
42+
<td>Fast, Scalable Full-text Search</td>
43+
<td>Application and Infrastructure Monitoring</td>
44+
<td>Security and Event Information Management</td>
45+
<td>Operational Health Tracking</td>
46+
</tr>
47+
<tr style="text-align: left; vertical-align:top;">
48+
<td>Help users find the right information within your application, website, or data lake catalog. </td>
49+
<td>Easily store and analyze log data, and set automated alerts for underperformance.</td>
50+
<td>Centralize logs to enable real-time security monitoring and forensic analysis.</td>
51+
<td>Use observability logs, metrics, and traces to monitor your applications and business in real time.</td>
52+
</tr>
53+
</tbody>
54+
</table>
55+
56+
**Additional features and plugins:**
57+
58+
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.
59+
- [Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) - Identify atypical data and receive automatic notifications
60+
- [KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) - Find “nearest neighbors” in your vector data
61+
- [Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) - Monitor and optimize your cluster
62+
- [SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) - Use SQL or a piped processing language to query your data
63+
- [Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) - Automate index operations
64+
- [ML Commons plugin]({{site.url}}{{site.baseurl}}/ml-commons-plugin/index/) - Train and execute machine-learning models
65+
- [Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) - Run search requests in the background
66+
- [Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) - Replicate your data across multiple OpenSearch clusters
67+
68+
69+
## The secure path forward
70+
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.
71+
72+
## Looking for the Javadoc?
73+
74+
See [opensearch.org/javadocs/](https://opensearch.org/javadocs/).
75+
76+
## Get involved
77+
78+
[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/).
79+
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.
80+
81+
---
82+
83+
<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>

‎about.md renamed to ‎_about/intro.md

+3-10
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
11
---
22
layout: default
3-
title: About OpenSearch
3+
title: Intro to OpenSearch
44
nav_order: 2
5-
parent: OpenSearch documentation
6-
redirect_from:
7-
- /docs/opensearch/
8-
- /opensearch/
9-
- /opensearch/index/
105
---
116

12-
{%- comment -%}The `/docs/opensearch/` redirect is specifically to support the UI links in OpenSearch Dashboards 1.0.0.{%- endcomment -%}
13-
147
# Introduction to OpenSearch
158

169
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 indexes, boost fields, rank results by score, sort results by field, and aggregate results.
@@ -83,13 +76,13 @@ PUT https://<host>:<port>/<index-name>/_doc/<document-id>
8376

8477
To run a search for the document:
8578

86-
```
79+
```json
8780
GET https://<host>:<port>/<index-name>/_search?q=wind
8881
```
8982

9083
To delete the document:
9184

92-
```
85+
```json
9386
DELETE https://<host>:<port>/<index-name>/_doc/<document-id>
9487
```
9588

‎quickstart.md renamed to ‎_about/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: default
33
title: Quickstart
4-
parent: OpenSearch documentation
54
nav_order: 3
65
redirect_from:
76
- /opensearch/install/quickstart/
7+
- /quickstart/
88
---
99

1010
# Quickstart

‎version-history.md renamed to ‎_about/version-history.md

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
layout: default
33
title: Version history
44
nav_order: 4
5-
parent: OpenSearch documentation
65
permalink: /version-history/
76
---
87

‎_benchmark/index.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ nav_order: 1
55
has_children: false
66
nav_exclude: true
77
has_toc: false
8+
redirect_from:
9+
- /benchmark/
810
---
911

1012
# OpenSearch Benchmark

‎_config.yml

+53-11
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
title: OpenSearch documentation
1+
title: OpenSearch Documentation
22
description: >- # this means to ignore newlines until "baseurl:"
33
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.
44
baseurl: "/docs/latest" # the subpath of your site, e.g. /blog
@@ -109,10 +109,16 @@ collections:
109109
developer-documentation:
110110
permalink: /:collection/:path/
111111
output: true
112+
about:
113+
permalink: /:collection/:path/
114+
output: true
112115

113-
just_the_docs:
116+
opensearch_collection:
114117
# Define the collections used in the theme
115118
collections:
119+
about:
120+
name: About OpenSearch
121+
nav_fold: true
116122
install-and-configure:
117123
name: Install and upgrade
118124
nav_fold: true
@@ -169,15 +175,6 @@ just_the_docs:
169175
reporting:
170176
name: Reporting
171177
nav_fold: true
172-
clients:
173-
name: Clients
174-
nav_fold: true
175-
benchmark:
176-
name: OpenSearch Benchmark
177-
nav_fold: true
178-
data-prepper:
179-
name: Data Prepper
180-
nav_fold: true
181178
tools:
182179
name: Tools
183180
nav_fold: true
@@ -191,6 +188,51 @@ just_the_docs:
191188
name: Developer documentation
192189
nav_fold: true
193190

191+
clients_collection:
192+
collections:
193+
clients:
194+
name: Clients
195+
nav_fold: true
196+
197+
benchmark_collection:
198+
collections:
199+
benchmark:
200+
name: OpenSearch Benchmark
201+
nav_fold: true
202+
203+
data_prepper_collection:
204+
collections:
205+
data-prepper:
206+
name: Data Prepper
207+
nav_fold: true
208+
209+
# Defaults
210+
211+
defaults:
212+
-
213+
scope:
214+
path: "" # an empty string here means all files in the project
215+
values:
216+
section: "opensearch"
217+
section-name: "OpenSearch and OpenSearch Dashboards"
218+
-
219+
scope:
220+
path: "_data-prepper"
221+
values:
222+
section: "data-prepper"
223+
section-name: "Data Prepper"
224+
-
225+
scope:
226+
path: "_clients"
227+
values:
228+
section: "clients"
229+
section-name: "Clients"
230+
-
231+
scope:
232+
path: "_benchmark"
233+
values:
234+
section: "benchmark"
235+
section-name: "Benchmark"
194236

195237
# Enable or disable the site search
196238
# By default, just-the-docs enables its JSON file-based search. We also have an OpenSearch-driven search functionality.

‎_data/top_nav.yml

+20-2
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,26 @@ items:
8484
url: /community_projects
8585
-
8686
label: Documentation
87-
fragment: docs
88-
url: /docs/
87+
fragments:
88+
- docs
89+
- opensearch
90+
- data-prepper
91+
- clients
92+
- benchmark
93+
url: /docs/latest/
94+
children:
95+
-
96+
label: OpenSearch and Dashboards
97+
url: /docs/latest/about/
98+
-
99+
label: Data Prepper
100+
url: /docs/latest/data-prepper/
101+
-
102+
label: Clients
103+
url: /docs/latest/clients/
104+
-
105+
label: Benchmark
106+
url: /docs/latest/benchmark/
89107
-
90108
label: Platform
91109
url: /platform/index.html

‎_im-plugin/ism/policies.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Parameter | Description | Type | Required
168168
}
169169
```
170170

171-
For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/opensearch#primary-and-replica-shards).
171+
For information about setting replicas, see [Primary and replica shards]({{site.url}}{{site.baseurl}}/about/intro/#primary-and-replica-shards).
172172

173173
### shrink
174174

‎_includes/banner.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<section class="os-banner">
2-
<header class="banner-head" style="background-image: url('{{site.url}}{{site.baseurl}}/images/graphic-bg.png')">
2+
<header class="banner-head">
33
<div class="banner-text-div">
44
<span class="banner-text-header">OpenSearch Documentation</span>
55
<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>

‎_includes/cards.html

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<div class="card-container-wrapper">
2+
<p class="heading-main">Explore OpenSearch documentation</p>
3+
<div class="card-container">
4+
<div class="card">
5+
<a href="{{site.url}}{{site.baseurl}}/about/" class='card-link'></a>
6+
<p class="heading">OpenSearch and OpenSearch Dashboards</p>
7+
<p class="description">Learn how to power up your search</p>
8+
<button class="last-link">Documentation &#x2192;</button>
9+
</div>
10+
11+
12+
<div class="card">
13+
<a href="{{site.url}}{{site.baseurl}}/data-prepper/" class='card-link'></a>
14+
<p class="heading">Data Prepper</p>
15+
<p class="description">Prepare your data for OpenSearch</p>
16+
<button class="last-link" >Documentation &#x2192;</button>
17+
</div>
18+
19+
<div class="card">
20+
<a href="{{site.url}}{{site.baseurl}}/clients/" class='card-link'></a>
21+
<p class="heading">Clients</p>
22+
<p class="description">OpenSearch in your programming language</p>
23+
<button class="last-link">Documentation &#x2192;</button>
24+
</div>
25+
26+
27+
<div class="card">
28+
<a href="{{site.url}}{{site.baseurl}}/benchmark/" class='card-link'></a>
29+
<p class="heading">Benchmark</p>
30+
<p class="description">Track OpenSearch performance</p>
31+
<button class="last-link">Documentation &#x2192;</button>
32+
</div>
33+
</div>
34+
35+
</div>
36+
37+

‎_layouts/default.html

+28-7
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,20 @@
5656
Documentation <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-grid"></use></svg>
5757
</a>
5858
</div>
59-
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
59+
<nav role="navigation" aria-label="Main" id="site-nav" class="site-nav">
6060
<div class="version-wrapper">
61-
<version-selector selected="{{ site.data.versions.current }}"></version-selector>
62-
</div>
61+
{% if page.section == "opensearch" %}
62+
<a href="{{site.url}}{{site.baseurl}}/about/" class="site-category">{{ page.section-name }}</a>
63+
{% else %}
64+
<a href="{{site.url}}{{site.baseurl}}/{{ page.section}}/" class="site-category">{{ page.section-name }}</a>
65+
{% endif %}
66+
67+
<a href="{{site.url}}{{site.baseurl}}/" class="back-link">&#x2190; Back to docs home</a>
68+
69+
{% if page.section == "opensearch" %}
70+
<version-selector selected="{{ site.data.versions.current }}"></version-selector>
71+
{% endif %}
72+
</div>
6373
{% assign pages_top_size = site.html_pages
6474
| where_exp:"item", "item.title != nil"
6575
| where_exp:"item", "item.parent == nil"
@@ -68,9 +78,20 @@
6878
{% if pages_top_size > 0 %}
6979
{% include nav.html pages=site.html_pages key=nil expanded=true %}
7080
{% endif %}
71-
{% if site.just_the_docs.collections %}
72-
{% assign collections_size = site.just_the_docs.collections | size %}
73-
{% for collection_entry in site.just_the_docs.collections %}
81+
82+
{% if page.section == "opensearch" %}
83+
{% assign section = site.opensearch_collection.collections %}
84+
{% elsif page.section == "data-prepper" %}
85+
{% assign section = site.data_prepper_collection.collections %}
86+
{% elsif page.section == "clients" %}
87+
{% assign section = site.clients_collection.collections %}
88+
{% elsif page.section == "benchmark" %}
89+
{% assign section = site.benchmark_collection.collections %}
90+
{% endif %}
91+
92+
{% if section %}
93+
{% assign collections_size = section | size %}
94+
{% for collection_entry in section %}
7495
{% assign collection_key = collection_entry[0] %}
7596
{% assign collection_value = collection_entry[1] %}
7697
{% assign collection = site[collection_key] %}
@@ -204,7 +225,7 @@ <h2>Related articles</h2>
204225
<div class="toc-wrap">
205226
<div class="sticky-wrap">
206227
<div class="toc">
207-
{% include toc.html html=content h_min=2 h_max=2 class="toc-list" item_class="toc-item" sanitize=true %}
228+
{% include toc.html html=content h_min=2 h_max=3 class="toc-list" item_class="toc-item" sanitize=true %}
208229
</div>
209230
{% include feedback.html %}
210231
</div>

0 commit comments

Comments
 (0)