Skip to content

Commit

Permalink
Fixes to redirects (#4195)
Browse files Browse the repository at this point in the history
* redirects

Signed-off-by: Heather Halter <[email protected]>

* fixedformat

Signed-off-by: Heather Halter <[email protected]>

* fixbrokenlink

Signed-off-by: Heather Halter <[email protected]>

* fixbrokenlink

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
  • Loading branch information
hdhalter authored May 26, 2023
1 parent 07bfd7c commit 837112f
Show file tree
Hide file tree
Showing 37 changed files with 62 additions and 21 deletions.
3 changes: 2 additions & 1 deletion _api-reference/cat/cat-cluster_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
layout: default
title: CAT cluster manager
parent: CAT API

redirect_from:
- /opensearch/rest-api/cat/cat-master/
nav_order: 30
has_children: false
---
Expand Down
2 changes: 1 addition & 1 deletion _api-reference/document-apis/index-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Index document
parent: Document APIs
nav_order: 1
redirect_from:
- /opensearch/rest-api/document-apis/index-document
- /opensearch/rest-api/document-apis/index-document/
---

# Index document
Expand Down
4 changes: 2 additions & 2 deletions _api-reference/document-apis/multi-get.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ title: Multi-get document
parent: Document APIs
nav_order: 30
redirect_from:
- /opensearch/rest-api/document-apis/mulit-get/
- /opensearch/rest-api/document-apis/multi-get/
---

# Multi-get documents
Introduced 1.0
{: .label .label-purple }

The multi-get operation allows you to execute multiple GET operations in one request, so you can get back all documents that match your criteria.
The multi-get operation allows you to run multiple GET operations in one request, so you can get back all documents that match your criteria.

## Example without specifying index in URL

Expand Down
3 changes: 2 additions & 1 deletion _api-reference/document-apis/reindex.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Reindex document
parent: Document APIs
nav_order: 60
redirect_from:
- /opensearch/reindex-data/
- /opensearch/reindex-data/
- /opensearch/rest-api/document-apis/reindex/
---

# Reindex document
Expand Down
1 change: 1 addition & 0 deletions _api-reference/index-apis/put-mapping.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Index APIs
nav_order: 27
redirect_from:
- /opensearch/rest-api/index-apis/update-mapping/
- /opensearch/rest-api/update-mapping/
---

# Create or update mappings
Expand Down
2 changes: 2 additions & 0 deletions _im-plugin/ism/managedindexes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Managed indexes
nav_order: 3
parent: Index State Management
has_children: false
redirect_from:
- /im-plugin/ism/managedindices/
---

# Managed indexes
Expand Down
1 change: 1 addition & 0 deletions _install-and-configure/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Configuring OpenSearch
nav_order: 10
redirect_from:
- /install-and-configure/configuration/
- /opensearch/configuration/
---

# Configuring OpenSearch
Expand Down
6 changes: 3 additions & 3 deletions _install-and-configure/install-dashboards/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: Managing OpenSearch Dashboards plugins
nav_order: 100
redirect_from:
- /dashboards/install/plugins
- /dashboards/install/plugins/
- /install-and-configure/install-dashboards/plugins/
---

Expand Down Expand Up @@ -149,7 +149,7 @@ sudo bin/opensearch-dashboards-plugin remove <plugin-name>

Then remove all associated entries from `opensearch_dashboards.yml`.

For certain plugins, you must also remove the "optimze" bundle. This is a sample command for the Anomaly Detection plugin:
For certain plugins, you must also remove the "optimize" bundle. This is a sample command for the Anomaly Detection plugin:

```bash
sudo rm /usr/share/opensearch-dashboards/optimize/bundles/opensearch-anomaly-detection-opensearch-dashboards.*
Expand Down Expand Up @@ -181,7 +181,7 @@ OpenSearch Dashboards doesn’t update plugins. Instead, you have to remove the

1. Restart OpenSearch Dashboards.

For example, to remove and reinstall the anomaly detection plugin:
For example, to remove and reinstall the Anomaly Detection plugin:

```bash
sudo bin/opensearch-plugin remove opensearch-anomaly-detection
Expand Down
2 changes: 1 addition & 1 deletion _observing-your-data/notebooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ layout: default
title: Notebooks
nav_order: 50
redirect_from:
- /notebooks/
- /dashboards/notebooks/
- /observability-plugin/notebooks/
has_children: false
---
Expand Down
1 change: 1 addition & 0 deletions _observing-your-data/trace/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Trace Analytics
nav_order: 1
redirect_from:
- /observability-plugin/trace/get-started/
- /monitoring-plugins/trace/get-started/
---

# Getting started with Trace Analytics
Expand Down
1 change: 1 addition & 0 deletions _observing-your-data/trace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ has_children: true
has_toc: false
redirect_from:
- /observability-plugin/trace/index/
- /monitoring-plugins/trace/index/
---

# Trace Analytics
Expand Down
3 changes: 2 additions & 1 deletion _observing-your-data/trace/ta-dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Trace Analytics
nav_order: 50
redirect_from:
- /observability-plugin/trace/ta-dashboards/
- /monitoring-plugins/trace/ta-dashboards/
---

# Trace Analytics OpenSearch Dashboards plugin
Expand All @@ -15,7 +16,7 @@ The **Dashboard** view groups traces together by HTTP method and path so that yo

![Dashboard view]({{site.url}}{{site.baseurl}}/images/ta-dashboard.png)

To drill down on the traces that make up a trace group, choose the number of traces in righthand column. Then choose an individual trace for a detailed summary.
To drill down on the traces that make up a trace group, choose the number of traces in the column on the right. Then choose an individual trace for a detailed summary.

![Detailed trace view]({{site.url}}{{site.baseurl}}/images/ta-trace.png)

Expand Down
2 changes: 2 additions & 0 deletions _query-dsl/aggregations/pipeline-agg.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ parent: Aggregations
nav_order: 5
permalink: /aggregations/pipeline-agg/
has_children: false
redirect_from:
- /opensearch/pipeline-agg/
---

# Pipeline aggregations
Expand Down
6 changes: 3 additions & 3 deletions _search-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ nav_exclude: true

OpenSearch provides several features for customizing your search use cases and improving search relevance. In OpenSearch, you can:

- Use [SQL and Piped Processing Language (PPL)]({{site.url}}{{site.baseurl}}/search-plugins/sql/) as alternatives to [query domain-specific language (DSL)]({{site.url}}{{site.baseurl}}/query-dsl/) to search data.
- Use [SQL and Piped Processing Language (PPL)]({{site.url}}{{site.baseurl}}/search-plugins/sql/index/) as alternatives to [query domain-specific language (DSL)]({{site.url}}{{site.baseurl}}/query-dsl/) to search data.

- Run resource-intensive queries asynchronously with [asynchronous search]({{site.url}}{{site.baseurl}}/search-plugins/async/).

Expand All @@ -25,6 +25,6 @@ OpenSearch provides several features for customizing your search use cases and i

- Use a dataset that is fixed in time to paginate results with [Point in Time]({{site.url}}{{site.baseurl}}/search-plugins/point-in-time/).

- [Paginate]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/paginate) and [sort]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/sort/) search results, [highlight]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/highlight/) search terms, and use the [autocomplete]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/autocomplete/) and [did-you-mean]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/did-you-mean/) functionality.
- [Paginate]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/paginate/) and [sort]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/sort/) search results, [highlight]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/highlight/) search terms, and use the [autocomplete]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/autocomplete/) and [did-you-mean]({{site.url}}{{site.baseurl}}/search-plugins/searching-data/did-you-mean/) functionality.

- Rewrite queries with [Querqy]({{site.url}}{{site.baseurl}}/search-plugins/querqy).
- Rewrite queries with [Querqy]({{site.url}}{{site.baseurl}}/search-plugins/querqy/).
2 changes: 2 additions & 0 deletions _search-plugins/knn/jni-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: JNI libraries
nav_order: 35
parent: k-NN
has_children: false
redirect_from:
- /search-plugins/knn/jni-library/
---

# JNI libraries
Expand Down
2 changes: 2 additions & 0 deletions _search-plugins/sql/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: SQL and PPL CLI
parent: SQL and PPL
nav_order: 3
redirect_from:
- /search-plugins/sql/cli/
---

# SQL and PPL CLI
Expand Down
2 changes: 1 addition & 1 deletion _search-plugins/sql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 38
has_children: true
has_toc: false
redirect_from:
- /search-plugins/sql/
- /search-plugins/sql/index/
---

# SQL and PPL
Expand Down
2 changes: 2 additions & 0 deletions _search-plugins/sql/ppl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ redirect_from:
- /search-plugins/ppl/
- /observability-plugin/ppl/
- /search-plugins/ppl/index/
- /search-plugins/ppl/endpoint/
- /search-plugins/ppl/protocol/
---

# PPL &ndash; Piped Processing Language
Expand Down
4 changes: 2 additions & 2 deletions _search-plugins/sql/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /search-plugins/sql/settings/
---

# Settings
# SQL settings

The SQL plugin adds a few settings to the standard OpenSearch cluster settings. Most are dynamic, so you can change the default behavior of the plugin without restarting your cluster.

Expand Down Expand Up @@ -75,6 +75,6 @@ Setting | Default | Description
`plugins.sql.enabled` | True | Change to `false` to disable the `SQL` support in the plugin.
`plugins.ppl.enabled` | True | Change to `false` to disable the `PPL` support in the plugin.
`plugins.sql.slowlog` | 2 seconds | Configures the time limit (in seconds) for slow queries. The plugin logs slow queries as `Slow query: elapsed=xxx (ms)` in `opensearch.log`.
`plugins.sql.cursor.keep_alive` | 1 minute | Configures how long the cursor context is kept open. Cursor contexts are resource resource intensive, so we recommend a low value.
`plugins.sql.cursor.keep_alive` | 1 minute | Configures how long the cursor context is kept open. Cursor contexts are resource-intensive, so we recommend a low value.
`plugins.query.memory_limit` | 85% | Configures the heap memory usage limit for the circuit breaker of the query engine.
`plugins.query.size_limit` | 200 | Sets the default size of index that the query engine fetches from OpenSearch.
1 change: 1 addition & 0 deletions _security/access-control/cross-cluster-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 105
redirect_from:
- /security/access-control/cross-cluster-search/
- /security-plugin/access-control/cross-cluster-search/
---

# Cross-cluster search
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/default-action-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 115
redirect_from:
- /security/access-control/default-action-groups/
- /security-plugin/access-control/default-action-groups/
---

# Default action groups
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/document-level-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 85
redirect_from:
- /security/access-control/document-level-security/
- /security-plugin/access-control/document-level-security/
---

# Document-level security (DLS)
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/field-level-security.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 90
redirect_from:
- /security/access-control/field-level-security/
- /security-plugin/access-control/field-level-security/
---

# Field-level security
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/field-masking.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 95
redirect_from:
- /security/access-control/field-masking/
- /security-plugin/access-control/field-masking/
---

# Field masking
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/impersonation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 100
redirect_from:
- /security/access-control/impersonation/
- /security-plugin/access-control/impersonation/
---

# User impersonation
Expand Down
1 change: 1 addition & 0 deletions _security/access-control/users-roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Access control
nav_order: 80
redirect_from:
- /security/access-control/users-roles/
- /security-plugin/access-control/users-roles/
---

# Users and roles
Expand Down
1 change: 1 addition & 0 deletions _security/audit-logs/field-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Audit logs
nav_order: 130
redirect_from:
- /security/audit-logs/field-reference/
- /security-plugin/audit-logs/field-reference/
---

# Audit log field reference
Expand Down
1 change: 1 addition & 0 deletions _security/audit-logs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ has_children: true
has_toc: false
redirect_from:
- /security/audit-logs/index/
- /security-plugin/audit-logs/index/
---

# Audit logs
Expand Down
1 change: 1 addition & 0 deletions _security/audit-logs/storage-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ parent: Audit logs
nav_order: 135
redirect_from:
- /security/audit-logs/storage-types/
- /security-plugin/audit-logs/storage-types/
---

# Audit log storage types
Expand Down
2 changes: 2 additions & 0 deletions _security/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Configuring the Security backend
parent: Configuration
nav_order: 5
redirect_from:
- /security-plugin/configuration/configuration/
---

# Configuring the Security backend
Expand Down
2 changes: 2 additions & 0 deletions _security/configuration/system-indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: System indexes
parent: Configuration
nav_order: 4
redirect_from:
- /security-plugin/configuration/system-indices/
---

# System indexes
Expand Down
8 changes: 5 additions & 3 deletions _tools/logstash/advanced-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Advanced configurations
parent: Logstash
nav_order: 230
redirect_from:
- /clients/logstash/advanced-config/
---

# Advanced configurations
Expand Down Expand Up @@ -89,7 +91,7 @@ if EXPR {
}
```

`EXPR` is any valid Logstash syntax that evaluates to a boolean value.
`EXPR` is any valid Logstash syntax that evaluates to a Boolean value.
For example, you can check if an event type is set to `access` or `error` and perform some action based on that:

```yml
Expand Down Expand Up @@ -126,7 +128,7 @@ if [some_field] in ["one", "two", "three"] {
}
```

You can use boolean operators:
You can use Boolean operators:

```yml
if [type] == "access" or [type] == "error" {
Expand Down Expand Up @@ -235,7 +237,7 @@ geoip {

Start Logstash and send an HTTP request.

Within the terminal, you see a new field named `geoip` that contains information such as the time zone, country, continent, city, postal code, and the latitude / longitude pair.
Within the terminal, you see a new field named `geoip` that contains information such as the time zone, country, continent, city, postal code, and the latitude/longitude pair.

If you only need the country name for instance, include an option named `fields` with an array of the field names that you want the `geoip` plugin to return.

Expand Down
2 changes: 2 additions & 0 deletions _tools/logstash/common-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Common filter plugins
parent: Logstash
nav_order: 220
redirect_from:
- /clients/logstash/common-filters/
---

# Common filter plugins
Expand Down
4 changes: 3 additions & 1 deletion _tools/logstash/execution-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Logstash execution model
parent: Logstash
nav_order: 210
redirect_from:
- /clients/logstash/execution-model/
---

# Logstash execution model
Expand All @@ -19,7 +21,7 @@ After receiving an event and possibly applying an input codec, Logstash sends th

A pipeline worker consumes events from the work queue in batches to optimize the throughput of the pipeline as a whole.

One reason why Logstash works in batches is that some code needs to be executed regardless of how many events are processed at a time within the pipeline worker. Instead of executing that code 100 times for 100 events, it’s more efficient to execute it once for a batch of 100 events.
One reason why Logstash works in batches is that some code needs to be executed regardless of how many events are processed at a time within the pipeline worker. Instead of executing that code 100 times for 100 events, it’s more efficient to run it once for a batch of 100 events.

Another reason is that a few output plugins group together events as batches. For example, if you send 100 requests to OpenSearch, the OpenSearch output plugin uses the bulk API to send a single request that groups together the 100 requests.

Expand Down
2 changes: 2 additions & 0 deletions _tools/logstash/read-from-opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Read from OpenSearch
parent: Logstash
nav_order: 220
redirect_from:
- /clients/logstash/ship-to-opensearch/
---

# Read from OpenSearch
Expand Down
2 changes: 2 additions & 0 deletions _tools/logstash/ship-to-opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ layout: default
title: Ship events to OpenSearch
parent: Logstash
nav_order: 220
redirect_from:
- /clients/logstash/ship-to-opensearch/
---

# Ship events to OpenSearch
Expand Down
Loading

0 comments on commit 837112f

Please sign in to comment.