Skip to content

Commit

Permalink
fixing broken link in 'PPL' documentation under 'Search' section (#5528)
Browse files Browse the repository at this point in the history
Signed-off-by: Samuel Valdes Gutierrez <[email protected]>
(cherry picked from commit 4848ca3)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] committed Nov 7, 2023
1 parent f90e139 commit ab17a28
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions _search-plugins/sql/ppl/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ redirect_from:

# PPL

Piped Processing Language (PPL) is a query language that focuses on processing data in a sequential, step-by-step manner. PPL uses the pipe (`|`) operator to combine commands to find and retrieve data. It is the primary language used with observability in OpenSearch and supports multi-data queries.
Piped Processing Language (PPL) is a query language that focuses on processing data in a sequential, step-by-step manner. PPL uses the pipe (`|`) operator to combine commands to find and retrieve data. It is the primary language used with observability in OpenSearch and supports multi-data queries.

## PPL syntax

Expand All @@ -31,17 +31,17 @@ See [Syntax]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/syntax/) for sp

## PPL commands

PPL filters, transforms, and aggregates data using a series of commands. See [Commands](/search-plugins/sql/ppl/functions/) for a description and an example of each command.
PPL filters, transforms, and aggregates data using a series of commands. See [Commands]({{site.url}}{{site.baseurl}}/search-plugins/sql/ppl/functions/) for a description and an example of each command.

## Using PPL within OpenSearch
## Using PPL within OpenSearch

Check failure on line 36 in _search-plugins/sql/ppl/index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] _search-plugins/sql/ppl/index.md#L36

[OpenSearch.HeadingCapitalization] 'Using PPL within OpenSearch' is a heading and should be in sentence case.
Raw output
{"message": "[OpenSearch.HeadingCapitalization] 'Using PPL within OpenSearch' is a heading and should be in sentence case.", "location": {"path": "_search-plugins/sql/ppl/index.md", "range": {"start": {"line": 36, "column": 4}}}, "severity": "ERROR"}

To use PPL, you must have installed OpenSearch Dashboards. PPL is available within the [Query Workbench tool](https://playground.opensearch.org/app/opensearch-query-workbench#/). See the [Query Workbench]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/) documentation for a tutorial on using PPL within OpenSearch.

## Developer documentation

Developers can find information in the following resources:

- [Piped Processing Language](https://github.com/opensearch-project/piped-processing-language) specification
- [OpenSearch PPL Reference Manual](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/index.rst)
- [Piped Processing Language](https://github.com/opensearch-project/piped-processing-language) specification
- [OpenSearch PPL Reference Manual](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/index.rst)
- [Observability](https://github.com/opensearch-project/dashboards-observability/) using [PPL-based visualizations](https://github.com/opensearch-project/dashboards-observability#event-analytics)
- PPL [Data Types](https://github.com/opensearch-project/sql/blob/main/docs/user/ppl/general/datatypes.rst)

0 comments on commit ab17a28

Please sign in to comment.