Skip to content

docs: Refactor the page explaining how to deploy Presto with Docker#26870

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
dnskr:refactor-deploy-docker-page
Jan 20, 2026
Merged

docs: Refactor the page explaining how to deploy Presto with Docker#26870
steveburnett merged 1 commit intoprestodb:masterfrom
dnskr:refactor-deploy-docker-page

Conversation

@dnskr
Copy link
Copy Markdown
Contributor

@dnskr dnskr commented Dec 29, 2025

Description

  • Refactor the documentation page that explains how to deploy Presto with Docker.
  • Make minor adjustments to the Installation menu and related documentation page names.
  • Remove sphinx-copybutton dependency.
  • Remove duplicated configuration property templates_path = ['_templates'].

Motivation and Context

Documentation configs:

  • The sphinx-copybutton dependency is redundant and does not function correctly because copy buttons for code block are already provided globally by the content.code.copy feature of the sphinx-immaterial theme.

Refining documentation and visual styling:

  • Reordered Installation menu from local to containerized options.
  • Changed documentation page names for common pattern Deploy Presto with *****.
  • Specified/refined code block lexers and used note directives.
image

Impact

None

Test Plan

Build the documentation and check that the page is correct:

presto-docs/build
open presto-docs/target/html/installation/deploy-docker.html

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

@dnskr dnskr requested review from a team, elharo and steveburnett as code owners December 29, 2025 01:39
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Dec 29, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refactors the Presto Docker deployment documentation and aligns the Installation section structure and page titles around a consistent "Deploy Presto with ..." pattern, while improving code block formatting and callout notes across related installation pages.

File-Level Changes

Change Details Files
Reordered and renamed entries in the Installation index to prefer local-first installation flow and consistent page naming.
  • Updated the installation index to list local installation options before containerized options
  • Renamed installation pages to follow the common "Deploy Presto with ..." naming pattern
  • Ensured links and toctree entries match the new file/page titles
presto-docs/src/main/sphinx/installation.rst
Refactored the Homebrew installation page for naming consistency and minor formatting improvements.
  • Adjusted page title and headings to the "Deploy Presto with Homebrew" pattern
  • Cleaned up prose and section structure as needed to align with other installation docs
presto-docs/src/main/sphinx/installation/deploy-brew.rst
Refactored the Docker deployment documentation page, improving structure, styling, and code samples.
  • Rewrote or reorganized sections to better explain how to deploy Presto with Docker
  • Standardized code block lexers for shell, YAML, and other snippets
  • Added or updated note directives for important caveats and tips
  • Aligned titles and anchors with the new naming pattern
presto-docs/src/main/sphinx/installation/deploy-docker.rst
Aligned Helm deployment documentation with the new naming and formatting conventions.
  • Updated page name and headings to the "Deploy Presto with Helm" pattern
  • Standardized code block lexers and directive usage where appropriate
presto-docs/src/main/sphinx/installation/deploy-helm.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

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.

Thanks for the doc! A couple of minor notes.

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to 🏗 In progress in Presto Documentation Jan 8, 2026
@dnskr dnskr force-pushed the refactor-deploy-docker-page branch 2 times, most recently from fe320d2 to 719e289 Compare January 11, 2026 19:14
@github-actions github-actions bot removed the docs label Jan 11, 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 Jan 12, 2026
@dnskr dnskr force-pushed the refactor-deploy-docker-page branch from 719e289 to 847868a Compare January 18, 2026 11:47
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!

@steveburnett steveburnett merged commit fe2f09e into prestodb:master Jan 20, 2026
78 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants