[DOC-14595][AI] Document disk_io_optimized for reader and writer threads - #4158
Draft
TimLFletcher wants to merge 1 commit into
Draft
[DOC-14595][AI] Document disk_io_optimized for reader and writer threads#4158TimLFletcher wants to merge 1 commit into
TimLFletcher wants to merge 1 commit into
Conversation
The Setting Storage Thread Allocations reference described num_reader_threads and num_writer_threads as taking a number of threads, without mentioning that they also accept disk_io_optimized. That value corresponds to the Disk i/o optimized option already documented under Data Settings, which storage-engines.adoc recommends for Magma buckets. Adds the accepted value to both parameter descriptions and to the curl syntax block, and links to Data Settings for guidance on when to use it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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.
Fixes DOC-14595.
What changed
modules/rest-api/pages/rest-reader-writer-thread-config.adoc(Setting Storage Thread Allocations).num_reader_threadsandnum_writer_threadswere described only as taking a number of threads. Neither mentioneddisk_io_optimized, so a reader working from the REST reference had no way to discover it. Added the accepted value to both parameter descriptions and to the curl syntax block, with a link to Data Settings for guidance on when to use it.Where the facts came from
Nothing here is invented. Every claim traces to the ticket or to existing pages in this repository:
disk_io_optimizedis accepted by both parameterscurlexamplemanage/manage-settings/general-settings.adoc:224learn/buckets-memory-and-storage/storage-engines.adoc:49I deliberately did not add
defaultas a documented value. The UI has a Default option and the siblingnum_nonio_threadsparameter documents adefaultvalue, so it is probably accepted here too, but neither the ticket nor this repository states it. Worth a follow-up if someone can confirm.Verification
Anchor
[#data-settings]confirmed atgeneral-settings.adoc:196, by inspection, since Antora validates xref page targets but not#fragmentanchors.🤖 Generated with Claude Code