docs: extract storage related documentation as a dedicated guide#243
Merged
Conversation
GrigoryPervakov
changed the title
GrigoryPervakov
left a comment
GrigoryPervakov
left a comment
Member
There was a problem hiding this comment.
Accurate and reads well. One scope nit: a usage/behaviour guide should not pin internal details that can change without notice. Three to drop from storage.mdx:
- The rendered
storage_configurationblock in the JBOD section — themainvolume name is an internal template detail, not a contract. The prose below it (round-robin across all disks, capacity = sum) is what users actually rely on. - The generated filename
10-storage-jbod.yaml— internal config.d plumbing. "Generates thestorage_configurationfor you" is enough. - The verbatim webhook warning string — describe the behaviour instead of quoting the message text, which is free to change.
Everything else — mount paths, the hyphen→underscore identifier rule, immutability rules, and the validation table — is the right level for a behaviour guide.
Note: this review was AI-generated.
A behaviour guide should not pin internal details that can change without notice: the rendered storage_configuration block (the `main` volume name is a template detail), the generated 10-storage-jbod.yaml filename, and the verbatim webhook warning string. Keep the prose that describes the actual behaviour.
GrigoryPervakov
force-pushed
the
docs/storage-guide
branch
from
b3545f4 to
67d80e7
Compare
|
Docs PR opened: ClickHouse/mintlify-docs-dev#248 Synced upstream PR #243 by adding a new storage guide and updating overview, guides, install pages, and API reference. |
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
2 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.
Why
The Configuration guide currently includes storage details inline, but storage has enough operational behavior and validation rules to deserve a dedicated guide. Users need one place that explains how dataVolumeClaimSpec, ephemeral/custom volumes, PVC expansion, and multi-disk JBOD behave, especially which storage layout changes are rejected after cluster creation.
What
Adds a dedicated Storage and volumes guide and links it from the Guides navigation. The new guide extracts and expands the existing storage documentation with primary PVC behavior, ephemeral storage warnings, expansion requirements, JBOD-generated storage_configuration, custom storage policy guidance, immutability rules, and a validation reference for common rejected configurations. The Configuration guide now keeps a short storage overview and links to the new dedicated page.