docs: document online index building - #4562
Merged
alecgrieser merged 1 commit intoSep 4, 2026
Merged
Conversation
Add a user-guide page for OnlineIndexer: basic build vs rebuild, limit/throttle options, mutual indexing across processes, and building from a source index.
alecgrieser
changed the title
Collaborator
|
I'm not sure we should block it on this, but this is one where it would be nice to have #4510 so that we could preview the new pages and also validate that there's not something like a broken link that the sphinx build would catch. |
alecgrieser
approved these changes
Sep 4, 2026
alecgrieser
left a comment
alecgrieser
left a comment
Collaborator
There was a problem hiding this comment.
This LGTM, but I've also flagged @jjezra as a reviewer as he's been leading the online indexer work. (He's also out until Tuesday, so it may be a few days before this is merged.) There are a few places where I may adjust the wording, but I also think it's probably good to merge this in first (unless there are things we think are actively wrong or misleading) and then iterating from there.
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
3 participants
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.
Adds a user-guide page for OnlineIndexer.
SchemaEvolution already explains when a new index is marked write-only. This page covers how to finish that build:
buildIndexvsrebuildIndex, the limit/throttle/transaction-time knobs, mutual indexing so several processes can split the key space, and building from a source index.Fixes #1045