opensearch-project / opensearch-project/sql
[DOC] Calcite settings documentation missing examples
Nobody has claimed this yet.
- 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:
- The Calcite settings section does not include example showing how users can actually modify these settings.
- The reference to
introduce v3 engineappears to be broken.
Version: 2.19 - 3.3
What other resources are available? N/A
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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