Skip to content

docs: Improve documentation for deploying custom plugins#27407

Merged
steveburnett merged 3 commits intoprestodb:masterfrom
saurabhmahawar:improve-plugin-deployment
Mar 24, 2026
Merged

docs: Improve documentation for deploying custom plugins#27407
steveburnett merged 3 commits intoprestodb:masterfrom
saurabhmahawar:improve-plugin-deployment

Conversation

@saurabhmahawar
Copy link
Copy Markdown
Contributor

@saurabhmahawar saurabhmahawar commented Mar 23, 2026

Description

Improve and expand the documentation for deploying custom plugins in Presto. This addresses the gap where users configuring connectors (such as the Google Sheets connector) are not informed that the corresponding plugin must be deployed before configuring a catalog.

Resolves: #24381 and #24365

Motivation and Context

The current documentation for deploying plugins is sparse (only 6 lines in the SPI Overview page under Developer Guide), difficult to discover, and lacks cross-references from connector documentation pages. This causes users to configure connectors without deploying the required plugin, resulting in Presto failing to start with a cryptic "No factory for connector" error.

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 ==

Summary by Sourcery

Update and expand documentation for deploying custom plugins and cross-reference it from relevant pages.

Documentation:

  • Add a dedicated installation guide page for deploying custom plugins and connectors.
  • Improve the SPI overview documentation around plugin deployment requirements.
  • Cross-link connector documentation, including the Google Sheets connector, to the custom plugin deployment instructions.
  • Update the main installation guide to reference the new custom plugin deployment documentation.

@saurabhmahawar saurabhmahawar requested review from a team, elharo and steveburnett as code owners March 23, 2026 07:32
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Mar 23, 2026
@prestodb-ci prestodb-ci requested review from a team, Dilli-Babu-Godari and nmahadevuni and removed request for a team March 23, 2026 07:32
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 23, 2026

🧙 Sourcery has finished reviewing your pull request!


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

Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • Since you’ve split out deploy-custom-plugins.rst from spi-overview.rst, consider centralizing the detailed deployment steps in the new page and keeping spi-overview.rst to a short conceptual summary with a clear link, to avoid future duplication and drift between the two.
  • Verify that the new installation/deploy-custom-plugins.rst page is included in the relevant Sphinx toctrees (e.g., main installation or developer docs TOCs) so it’s discoverable in the rendered docs, not just reachable via deep links from connector pages.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Since you’ve split out `deploy-custom-plugins.rst` from `spi-overview.rst`, consider centralizing the detailed deployment steps in the new page and keeping `spi-overview.rst` to a short conceptual summary with a clear link, to avoid future duplication and drift between the two.
- Verify that the new `installation/deploy-custom-plugins.rst` page is included in the relevant Sphinx toctrees (e.g., main installation or developer docs TOCs) so it’s discoverable in the rendered docs, not just reachable via deep links from connector pages.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! Just two nits of formatting, and a reorganization of some of the information that can be done as a later PR.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Mar 23, 2026
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! (docs)

Pull updated branch, new local doc build, looks good. Thanks!

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Presto Documentation Mar 23, 2026
Copy link
Copy Markdown
Contributor

@NivinCS NivinCS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the change, LGTM.

Copy link
Copy Markdown
Contributor

@Dilli-Babu-Godari Dilli-Babu-Godari left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM!

@steveburnett steveburnett merged commit fed2551 into prestodb:master Mar 24, 2026
83 checks passed
@saurabhmahawar saurabhmahawar deleted the improve-plugin-deployment branch March 25, 2026 10:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs from:IBM PR from IBM

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

[docs] Improve documentation for installing plugins

5 participants