opensearch-project / opensearch-project/sql

[DOC] Calcite settings documentation missing examples

Open Beginner friendly
#4,806 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation PPL
Dominant language
Java
Stars
176
Forks
229
Avg merge
2d 21h
Merged PRs (30d)
43

Description

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request.

The Calcite settings documentation is missing concrete examples and contains a broken reference:

  1. The Calcite settings section does not include example showing how users can actually modify these settings.
  2. The reference to introduce v3 engine appears to be broken.

Reference: https://github.com/opensearch-project/sql/blob/main/docs/user/admin/settings.rst#plugins-calcite-enabled

Version: 2.19 - 3.3

What other resources are available? N/A

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in docs/user/admin/settings.rst at the Calcite settings section, especially the plugins-calcite-enabled reference and the broken introduce v3 engine link. Check nearby documentation for the supported way to modify settings, then add concrete examples and repair the reference; the issue is done when both requests are reflected in the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.