Skip to content

docs: Add scale-writers property documentation#27110

Merged
hantangwangd merged 6 commits intoprestodb:masterfrom
garimauttam:docs/add-scale-writers-documentation
Feb 12, 2026
Merged

docs: Add scale-writers property documentation#27110
hantangwangd merged 6 commits intoprestodb:masterfrom
garimauttam:docs/add-scale-writers-documentation

Conversation

@garimauttam
Copy link
Copy Markdown
Contributor

@garimauttam garimauttam commented Feb 9, 2026

Description

Adds documentation for the scale-writers configuration property that was missing from the documentation.

Related Issue

Resolves #26303

Changes

  • Added scale_writers session property documentation in properties-session.rst
  • Added scale-writers configuration property documentation in properties.rst
  • Includes type, default value, and description

Testing

  • Built documentation successfully with ./build
  • No new errors or warnings
  • Verified formatting matches existing properties

== NO RELEASE NOTE ==

Summary by Sourcery

Document the scale-writers property in both session and configuration admin docs.

Documentation:

  • Add documentation for the scale_writers session property to the session properties reference.
  • Add documentation for the scale-writers configuration property, including type, default, and description, to the admin properties reference.

Document scale-writers configuration property in both session
properties and system properties documentation files.

Resolves: #26303
@garimauttam garimauttam requested review from a team, elharo and steveburnett as code owners February 9, 2026 08:42
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Feb 9, 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 reviewed your changes and they look great!


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.

steveburnett
steveburnett previously approved these changes Feb 9, 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 branch, local doc build, looks good. Thanks!

@github-project-automation github-project-automation bot moved this from 🆕 Unprioritized to ✅ Done in Presto Documentation Feb 9, 2026
Copy link
Copy Markdown
Member

@hantangwangd hantangwangd 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 this documentation supplement. Overall looks good to me, just a couple of minor comments left.

…ties

- Change default value of redistribute_writes from true to false
- Add documentation that scale_writers takes precedence when both are enabled
- Update both session and configuration property documentation
hantangwangd
hantangwangd previously approved these changes Feb 10, 2026
Copy link
Copy Markdown
Member

@hantangwangd hantangwangd left a comment

Choose a reason for hiding this comment

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

Thanks @garimauttam, lgtm!

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 update! Just two nits of formatting.

@github-project-automation github-project-automation bot moved this from ✅ Done to 🏗 In progress in Presto Documentation Feb 10, 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.

Three formatting nits in the cross-reference links, but everything else looks good. Thanks!

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 Feb 12, 2026
Copy link
Copy Markdown
Member

@hantangwangd hantangwangd left a comment

Choose a reason for hiding this comment

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

Thanks @garimauttam, lgtm!

@hantangwangd hantangwangd merged commit 932f85a into prestodb:master Feb 12, 2026
78 checks passed
@garimauttam garimauttam deleted the docs/add-scale-writers-documentation branch February 12, 2026 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

[doc] scale-writers is missing in Presto configuration properties

3 participants