Skip to content

Commit 03ae65b

Browse files
kolchfa-awskolchfa-aws
authored
Update and redirect main page in 1.2 (#10481)
* Correct menu for 1.2 Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Redirect index page to about and add version Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> * Apply suggestions from code review Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> * Update index.md Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com> --------- Signed-off-by: Fanit Kolchina <kolchfa@amazon.com> Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
1 parent f8db274 commit 03ae65b

3 files changed

Lines changed: 134 additions & 132 deletions

File tree

‎_includes/header.html‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
{%endif%}
1717
<div role="banner" id="top">
1818
<div class="container">
19-
<a class="logo" href="/">
19+
<a class="logo" href="https://opensearch.org/">
2020
OpenSearch
2121
<svg viewBox="0 0 372 72" fill="none" xmlns="http://www.w3.org/2000/svg">
2222
<path d="M61.7374 26.5C60.4878 26.5 59.4748 27.513 59.4748 28.7626C59.4748 47.3814 44.3814 62.4748 25.7626 62.4748C24.513 62.4748 23.5 63.4878 23.5 64.7374C23.5 65.987 24.513 67 25.7626 67C46.8805 67 64 49.8805 64 28.7626C64 27.513 62.987 26.5 61.7374 26.5Z" fill="#00A3E0"/>
@@ -30,11 +30,10 @@
3030
<div class="menu-button"><i class="icon icon-reorder"></i><span>Menu</span></div>
3131
<div class="nav-menu-on" role="navigation">
3232
<ul class="small-nav">
33-
{%- include nav_item.html text="News" href="/blog" url_full="/blog/" url_fragment="blog" -%}
34-
{%- include nav_item.html text="Source" href="/source.html" url_full="/source.html" url_fragment="source" -%}
35-
{%- include nav_item.html text="Documentation" href="/docs" url_full="/docs/" url_fragment="docs" -%}
36-
{%- include nav_item.html text="Events" href="/events" url_full="/events/" url_fragment="events" -%}
37-
{%- include nav_item.html text="Get Started" href="/downloads.html" url_full="/downloads.html" url_fragment="downloads" -%}
33+
{%- include nav_item.html text="Community" href="https://opensearch.org/community/" -%}
34+
{%- include nav_item.html text="Documentation" href="https://docs.opensearch.org/" -%}
35+
{%- include nav_item.html text="Blog" href="https://opensearch.org/blog/" -%}
36+
{%- include nav_item.html text="Download" href="https://opensearch.org/downloads.html" -%}
3837
</ul>
3938
</div>
4039
</div>

‎about.md‎

Lines changed: 126 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,131 @@
11
---
22
layout: default
3-
title: About OpenSearch
4-
nav_exclude: true
3+
title: Get started
4+
nav_order: 1
5+
redirect_from: /404.html
56
permalink: /about/
6-
redirect_to: /
77
canonical_url: https://opensearch.org/docs/latest/about/
88
---
9+
10+
# OpenSearch and OpenSearch Dashboards
11+
**Version {{site.opensearch_major_minor_version}}**
12+
{: .label .label-blue }
13+
14+
This site contains the technical documentation for [OpenSearch](https://opensearch.org/), the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
15+
16+
[Get started](#docker-quickstart){: .btn .btn-blue }
17+
18+
19+
---
20+
21+
## Why use OpenSearch?
22+
23+
OpenSearch is well-suited to the following use cases:
24+
25+
* Log analytics
26+
* Real-time application monitoring
27+
* Clickstream analytics
28+
* Search backend
29+
30+
Component | Purpose
31+
:--- | :---
32+
[OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/) | Data store and search engine
33+
[OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) | Search frontend and visualizations
34+
[Security]({{site.url}}{{site.baseurl}}/security-plugin/) | Authentication and access control for your cluster
35+
[Alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) | Receive notifications when your data meets certain conditions
36+
[SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) | Use SQL or a piped processing language to query your data
37+
[Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) | Automate index operations
38+
[KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) | Find “nearest neighbors” in your vector data
39+
[Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) | Monitor and optimize your cluster
40+
[Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications
41+
[Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background
42+
[Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) | Replicate your data across multiple OpenSearch clusters
43+
44+
Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
45+
46+
For specifics around the project, see the [FAQ](https://opensearch.org/faq/).
47+
48+
49+
---
50+
51+
## Docker quickstart
52+
Docker
53+
{: .label .label-green }
54+
55+
1. Install and start [Docker Desktop](https://www.docker.com/products/docker-desktop).
56+
1. Run the following commands:
57+
58+
```bash
59+
docker pull opensearchproject/opensearch:{{site.opensearch_version}}
60+
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}}
61+
```
62+
63+
1. In a new terminal session, run:
64+
65+
```bash
66+
curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200'
67+
```
68+
69+
1. [Create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) your first index.
70+
71+
```bash
72+
curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index'
73+
```
74+
75+
1. [Add some data]({{site.url}}{{site.baseurl}}/opensearch/index-data/) to your newly created index.
76+
77+
```bash
78+
curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' -H 'Content-Type: application/json' -d '{"Description": "To be or not to be, that is the question."}'
79+
```
80+
81+
1. [Retrieve the data]({{site.url}}{{site.baseurl}}/opensearch/index-data/#read-data) to see that it was added properly.
82+
83+
```bash
84+
curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1'
85+
```
86+
87+
1. After verifying that the data is correct, [delete the document]({{site.url}}{{site.baseurl}}/opensearch/index-data/#delete-data).
88+
89+
```bash
90+
curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1'
91+
```
92+
93+
1. Finally, [delete the index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/delete-index).
94+
95+
```bash
96+
curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/'
97+
```
98+
99+
To learn more, see [Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker/) and [Docker security configuration]({{site.url}}{{site.baseurl}}/opensearch/install/docker-security/).
100+
101+
102+
---
103+
104+
## Installation
105+
106+
For more comprehensive installation instructions for other download types, such as tarballs, see these pages:
107+
108+
- [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/)
109+
- [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/)
110+
111+
112+
## The secure path forward
113+
114+
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-plugin/configuration/index/): your own certificates, your own authentication method, your own users, and your own passwords.
115+
116+
117+
## Looking for the Javadoc?
118+
119+
See [opensearch.org/javadocs/](https://opensearch.org/javadocs/).
120+
121+
122+
## Get involved
123+
124+
[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/).
125+
126+
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.
127+
128+
129+
---
130+
131+
<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>

‎index.md‎

Lines changed: 3 additions & 123 deletions
Original file line numberDiff line numberDiff line change
@@ -1,129 +1,9 @@
11
---
22
layout: default
3-
title: Get started
4-
nav_order: 1
5-
redirect_from: /404.html
3+
title: OpenSearch Documentation
4+
nav_exclude: true
5+
redirect_to: /about/
66
permalink: /
77
canonical_url: https://docs.opensearch.org/latest/about/
88
---
99

10-
# OpenSearch documentation
11-
12-
This site contains the technical documentation for [OpenSearch](https://opensearch.org/), the Apache 2.0-licensed search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
13-
14-
[Get started](#docker-quickstart){: .btn .btn-blue }
15-
16-
17-
---
18-
19-
## Why use OpenSearch?
20-
21-
OpenSearch is well-suited to the following use cases:
22-
23-
* Log analytics
24-
* Real-time application monitoring
25-
* Clickstream analytics
26-
* Search backend
27-
28-
Component | Purpose
29-
:--- | :---
30-
[OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/) | Data store and search engine
31-
[OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/) | Search frontend and visualizations
32-
[Security]({{site.url}}{{site.baseurl}}/security-plugin/) | Authentication and access control for your cluster
33-
[Alerting]({{site.url}}{{site.baseurl}}/monitoring-plugins/alerting/) | Receive notifications when your data meets certain conditions
34-
[SQL]({{site.url}}{{site.baseurl}}/search-plugins/sql/) | Use SQL or a piped processing language to query your data
35-
[Index State Management]({{site.url}}{{site.baseurl}}/im-plugin/) | Automate index operations
36-
[KNN]({{site.url}}{{site.baseurl}}/search-plugins/knn/) | Find “nearest neighbors” in your vector data
37-
[Performance Analyzer]({{site.url}}{{site.baseurl}}/monitoring-plugins/pa/) | Monitor and optimize your cluster
38-
[Anomaly detection]({{site.url}}{{site.baseurl}}/monitoring-plugins/ad/) | Identify atypical data and receive automatic notifications
39-
[Asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/) | Run search requests in the background
40-
[Cross-cluster replication]({{site.url}}{{site.baseurl}}/replication-plugin/index/) | Replicate your data across multiple OpenSearch clusters
41-
42-
Most OpenSearch plugins have corresponding OpenSearch Dashboards plugins that provide a convenient, unified user interface.
43-
44-
For specifics around the project, see the [FAQ](https://opensearch.org/faq/).
45-
46-
47-
---
48-
49-
## Docker quickstart
50-
Docker
51-
{: .label .label-green }
52-
53-
1. Install and start [Docker Desktop](https://www.docker.com/products/docker-desktop).
54-
1. Run the following commands:
55-
56-
```bash
57-
docker pull opensearchproject/opensearch:{{site.opensearch_version}}
58-
docker run -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:{{site.opensearch_version}}
59-
```
60-
61-
1. In a new terminal session, run:
62-
63-
```bash
64-
curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200'
65-
```
66-
67-
1. [Create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/create-index/) your first index.
68-
69-
```bash
70-
curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index'
71-
```
72-
73-
1. [Add some data]({{site.url}}{{site.baseurl}}/opensearch/index-data/) to your newly created index.
74-
75-
```bash
76-
curl -XPUT --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1' -H 'Content-Type: application/json' -d '{"Description": "To be or not to be, that is the question."}'
77-
```
78-
79-
1. [Retrieve the data]({{site.url}}{{site.baseurl}}/opensearch/index-data/#read-data) to see that it was added properly.
80-
81-
```bash
82-
curl -XGET --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1'
83-
```
84-
85-
1. After verifying that the data is correct, [delete the document]({{site.url}}{{site.baseurl}}/opensearch/index-data/#delete-data).
86-
87-
```bash
88-
curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/_doc/1'
89-
```
90-
91-
1. Finally, [delete the index]({{site.url}}{{site.baseurl}}/opensearch/rest-api/index-apis/delete-index).
92-
93-
```bash
94-
curl -XDELETE --insecure -u 'admin:admin' 'https://localhost:9200/my-first-index/'
95-
```
96-
97-
To learn more, see [Docker image]({{site.url}}{{site.baseurl}}/opensearch/install/docker/) and [Docker security configuration]({{site.url}}{{site.baseurl}}/opensearch/install/docker-security/).
98-
99-
100-
---
101-
102-
## Installation
103-
104-
For more comprehensive installation instructions for other download types, such as tarballs, see these pages:
105-
106-
- [Install and configure OpenSearch]({{site.url}}{{site.baseurl}}/opensearch/install/)
107-
- [Install and configure OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/install/)
108-
109-
110-
## The secure path forward
111-
112-
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-plugin/configuration/index/): your own certificates, your own authentication method, your own users, and your own passwords.
113-
114-
115-
## Looking for the Javadoc?
116-
117-
See [opensearch.org/javadocs/](https://opensearch.org/javadocs/).
118-
119-
120-
## Get involved
121-
122-
[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/).
123-
124-
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.
125-
126-
127-
---
128-
129-
<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>

0 commit comments

Comments
 (0)