presto icon indicating copy to clipboard operation
presto copied to clipboard

docs(native): Add documentation for Presto C++ Installation

Open saurabhmahawar opened this issue 3 weeks ago • 2 comments

Description

Added new documentation explaining how to use the Presto C++ engine. The documentation provides step-by-step instructions for configuring, and running the Presto C++ worker

Motivation and Context

There was no consolidated or beginner-friendly documentation for Presto C++ in the open-source project. Users often had difficulty understanding how to build and run the C++ worker, what dependencies were required, and how it integrates with a Presto coordinator.

Impact

There is no performance impact.

Test Plan

Contributor checklist

  • [ ] Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • [ ] PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • [ ] Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • [ ] If release notes are required, they follow the release notes guidelines.
  • [ ] Adequate tests were added if applicable.
  • [ ] CI passed.
  • [ ] If adding new dependencies, verified they have an OpenSSF Scorecard score of 5.0 or higher (or obtained explicit TSC approval for lower scores).

Release Notes

== NO RELEASE NOTE ==

saurabhmahawar avatar Nov 28 '25 08:11 saurabhmahawar

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds new Sphinx documentation describing how to install and run the Presto C++ worker, including build, configuration, and integration steps, by introducing a dedicated installation guide and wiring it into the existing Presto C++ docs hierarchy.

File-Level Changes

Change Details Files
Introduce a dedicated installation guide for the Presto C++ worker.
  • Create a new Sphinx documentation page focused on installing and configuring the Presto C++ worker
  • Document prerequisites and dependencies required to build the C++ engine
  • Provide step-by-step instructions for building the worker from source and configuring it to connect to a Presto coordinator
  • Describe how to start and validate a running C++ worker instance
presto-docs/src/main/sphinx/presto_cpp/installation.rst
Wire the new installation guide into the existing Presto C++ documentation structure.
  • Update the main Presto C++ documentation index to reference the new installation guide
  • Ensure the new page participates in the Sphinx TOC so it appears in the rendered docs navigation
presto-docs/src/main/sphinx/presto-cpp.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an issue from a review comment by replying to it. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Nov 28 '25 08:11 sourcery-ai[bot]

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: saurabhmahawar / name: Saurabh Mahawar (e3a5a8d5350711d773dc08c36163cbdb1573bc82)