Skip to content

docs: add PPL Query Builder page - #383

Merged
anirudha merged 1 commit into
opensearch-project:mainfrom
joshuali925:docs-ppl-query-builder
Jul 31, 2026
Merged

docs: add PPL Query Builder page#383
anirudha merged 1 commit into
opensearch-project:mainfrom
joshuali925:docs-ppl-query-builder

Conversation

@joshuali925

Copy link
Copy Markdown
Member

Description

This PR adds PPL query builder docs. It adds a new docs page for query builder, and links it in logs discover docs page

Issues Resolved

List any issues this PR will resolve, e.g. Closes [...].

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Joshua Li <joshuali925@gmail.com>
@codecov

codecov Bot commented Jul 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.62%. Comparing base (c6d5505) to head (1fd4080).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #383   +/-   ##
=======================================
  Coverage   55.62%   55.62%           
=======================================
  Files           4        4           
  Lines         169      169           
  Branches       47       47           
=======================================
  Hits           94       94           
  Misses         74       74           
  Partials        1        1           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@anirudha
anirudha merged commit fa26d87 into opensearch-project:main Jul 31, 2026
8 checks passed
@joshuali925

Copy link
Copy Markdown
Member Author

@joshuali925-osdbot remove ## Enabling the builder section and relevant content added by this PR, and enable those feature flags by default for the observability stack setup, then send a PR

@joshuali925-osdbot

Copy link
Copy Markdown
Contributor

On it — I'll remove the ## Enabling the builder section from the query builder docs and enable the relevant feature flags by default in the observability stack setup, then open a PR.

@joshuali925-osdbot

Copy link
Copy Markdown
Contributor

Done — opened #387.

  • Enabled explore.logsQueryBuilder.enabled: true by default in the docker-compose OSD config and both Helm values files (values.yaml, values-anonymous-auth.yaml), which already set explore.enabled: true.
  • Removed the ## Enabling the builder section and the availability note from ppl/query-builder.md, plus the "how to enable it" reference on the discover-logs page.

Verified the docs build introduces no new broken links (same 41 pre-existing link-validator warnings on both main and the branch) and validated the YAML.

@joshuali925

Copy link
Copy Markdown
Member Author

@joshuali925-osdbot Send a PR to merge the query builder docs page into discover logs

@joshuali925-osdbot

Copy link
Copy Markdown
Contributor

On it — I'll open a PR that merges the PPL Query Builder docs page into the Discover Logs page and removes the standalone page.

@joshuali925-osdbot

Copy link
Copy Markdown
Contributor

Done — opened #390.

  • Merged the standalone PPL Query Builder page into the Discover Logs page as a new Building queries with the PPL Query Builder section (keeping all subsections: modes, searching, filtering, aggregating, sorting, running, worked example).
  • Removed ppl/query-builder.md and its sidebar entry, and repointed the in-page reference to the new section anchor.

Verified via the docs build that this introduces no new broken links (37 on the branch vs. 41 on main) and previewed locally — Discover Logs renders the merged section and the old page now 404s. Screenshot is in the PR description.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants