docs: Improve documentation for deploying custom plugins#27407
Merged
steveburnett merged 3 commits intoprestodb:masterfrom Mar 24, 2026
Merged
docs: Improve documentation for deploying custom plugins#27407steveburnett merged 3 commits intoprestodb:masterfrom
steveburnett merged 3 commits intoprestodb:masterfrom
Conversation
Contributor
|
🧙 Sourcery has finished reviewing your pull request! Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Contributor
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Since you’ve split out
deploy-custom-plugins.rstfromspi-overview.rst, consider centralizing the detailed deployment steps in the new page and keepingspi-overview.rstto 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.rstpage 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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
steveburnett
requested changes
Mar 23, 2026
Contributor
steveburnett
left a comment
There was a problem hiding this comment.
Looks good, thanks! Just two nits of formatting, and a reorganization of some of the information that can be done as a later PR.
presto-docs/src/main/sphinx/installation/deploy-custom-plugins.rst
Outdated
Show resolved
Hide resolved
presto-docs/src/main/sphinx/installation/deploy-custom-plugins.rst
Outdated
Show resolved
Hide resolved
steveburnett
approved these changes
Mar 23, 2026
Contributor
steveburnett
left a comment
There was a problem hiding this comment.
LGTM! (docs)
Pull updated branch, new local doc build, looks good. Thanks!
NivinCS
approved these changes
Mar 24, 2026
Contributor
NivinCS
left a comment
There was a problem hiding this comment.
Thanks for the change, LGTM.
This was referenced Mar 31, 2026
15 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
Release Notes
Summary by Sourcery
Update and expand documentation for deploying custom plugins and cross-reference it from relevant pages.
Documentation: