mention both Dashboards and endpoint #7638
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Old text said that Dashboards are a prerequisite for using PPL, and mentioned only the Query Workbench, not the _ppl endpoint. Is it really true that Dashboards are a prerequisite? Or is it just the SQL plugin that is a prerequisite? Signed-off-by: Stavros Macrakis <[email protected]>
smacrakis
requested review from
hdhalter,
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
Naarcha-AWS
approved these changes
Jul 8, 2024
_search-plugins/sql/ppl/index.md
Outdated
| @@ -37,7 +37,11 @@ PPL filters, transforms, and aggregates data using a series of commands. See [Co | |||
|
|
|||
| ## Using PPL within OpenSearch | |||
|
|
|||
| 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. | |||
| You can run PPL queries interactively in OpenSearch Dashboards or programmatically using the ``_ppl`` endpoint. | |||
There was a problem hiding this comment.
Suggested change
| You can run PPL queries interactively in OpenSearch Dashboards or programmatically using the ``_ppl`` endpoint. | |
| You can run PPL queries interactively in OpenSearch Dashboards or programmatically using the `_ppl` endpoint. |
| 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. | ||
| You can run PPL queries interactively in OpenSearch Dashboards or programmatically using the ``_ppl`` endpoint. | ||
|
|
||
| In OpenSearch Dashboards, the [Query Workbench tool](https://playground.opensearch.org/app/opensearch-query-workbench#/) provides an interactive testing environment, documented in [Query Workbench documentation]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/). |
There was a problem hiding this comment.
Suggested change
| In OpenSearch Dashboards, the [Query Workbench tool](https://playground.opensearch.org/app/opensearch-query-workbench#/) provides an interactive testing environment, documented in [Query Workbench documentation]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/). | |
| In OpenSearch Dashboards, the [Query Workbench tool](https://playground.opensearch.org/app/opensearch-query-workbench#/) provides an interactive testing environment. For more information, see the [Query Workbench documentation]({{site.url}}{{site.baseurl}}/dashboards/query-workbench/). |
|
@smacrakis: I believe its the SQL plugin, since you can make PPL requests using the API. |
|
Yes, I think the SQL plugin is required. Isn't it part of the default configuration? How do we generally document things like that? |
|
The SQL plugin is bundled up install. We list all of the default and available plugins the following page in the bundled plugins section. https://opensearch.org/docs/latest/install-and-configure/plugins/#bundled-plugins. |
|
Understood. Users who start with the "minimum distribution" need to know that PPL depends on the SQL plugin. Most users have the SQL plugin by default. What I was asking is how we document things like this, where the information is not relevant to most users, but still needs to be available. Maybe something like "PPL is implemented by the SQL plugin, which is included in OpenSearch by default (link)." I don't know enough about plugins to get that language exactly right. |
Signed-off-by: Naarcha-AWS <[email protected]>
|
I'll add that prerequisite as a note to this section. |
leanneeliatra
pushed a commit
to leanneeliatra/opensearch-documentation-website-forl
that referenced
this pull request
Jul 24, 2024
* mention both Dashboards and endpoint Old text said that Dashboards are a prerequisite for using PPL, and mentioned only the Query Workbench, not the _ppl endpoint. Is it really true that Dashboards are a prerequisite? Or is it just the SQL plugin that is a prerequisite? Signed-off-by: Stavros Macrakis <[email protected]> * Update index.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Stavros Macrakis <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: [email protected] <[email protected]>
sandervandegeijn
pushed a commit
to sandervandegeijn/documentation-website
that referenced
this pull request
Jul 30, 2024
* mention both Dashboards and endpoint Old text said that Dashboards are a prerequisite for using PPL, and mentioned only the Query Workbench, not the _ppl endpoint. Is it really true that Dashboards are a prerequisite? Or is it just the SQL plugin that is a prerequisite? Signed-off-by: Stavros Macrakis <[email protected]> * Update index.md Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Stavros Macrakis <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Sander van de Geijn <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Old text said that Dashboards are a prerequisite for using PPL, and mentioned only the Query Workbench, not the _ppl endpoint.
Is it really true that Dashboards are a prerequisite? Or is it just the SQL plugin that is a prerequisite?
Description
Describe what this change achieves.
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Version
List the OpenSearch version to which this PR applies, e.g. 2.14, 2.12--2.14, or all.
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.