Update docs.json - #746
Update docs.json#746
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
|
||
| ## Limitations | ||
|
|
||
| Global volumes use object-backed storage, not a POSIX file system. Review the following before using global volumes in production. |
There was a problem hiding this comment.
not a POSIX file system -> not a fully POSIX compliant file system
There was a problem hiding this comment.
Done — updated to "not a fully POSIX compliant file system." Pushed to this branch in commit 4053e32.
| Global volumes use object-backed storage, not a POSIX file system. Review the following before using global volumes in production. | ||
|
|
||
| - **Not suitable for training writes:** Writing large volumes of data such as checkpoints, logs, and activations to a global volume during training is not supported. Use a network volume for workloads that write frequently. | ||
| - **No POSIX semantics:** Global volumes do not support file locking, atomic rename, or hard links. Applications that depend on POSIX behavior may fail or produce unexpected results. |
There was a problem hiding this comment.
No POSIX semantics
-> Limited POSIX semantics
There was a problem hiding this comment.
Done — the label now reads "Limited POSIX semantics." Pushed to this branch in commit 4053e32.
| - **Not suitable for training writes:** Writing large volumes of data such as checkpoints, logs, and activations to a global volume during training is not supported. Use a network volume for workloads that write frequently. | ||
| - **No POSIX semantics:** Global volumes do not support file locking, atomic rename, or hard links. Applications that depend on POSIX behavior may fail or produce unexpected results. | ||
| - **No concurrent writes across Pods:** Multiple Pods writing to the same global volume concurrently can cause data corruption or overwrite conflicts. Use a network volume for shared mutable storage. | ||
| - **Object consistency:** Reads reflect the state of the volume at mount time. Updates made to the volume after the Pod starts may not be immediately visible inside the container. |
There was a problem hiding this comment.
Object consistency -> "Eventual consistency"
There was a problem hiding this comment.
Done — the label now reads "Eventual consistency." Pushed to this branch in commit 4053e32.
|
On it — applying the requested wording changes to |
|
@Promptless can you do a final check if we have applied all the rules from promptless.md file and runpod style guide |
|
On it — I'm reviewing the changes in this PR against the PROMPTLESS.md guidance and the Runpod style guide, and I'll follow up here with what I find. |
|
Update: I've reviewed the current changes against the PROMPTLESS.md guidance and the Runpod style guide. Most rules are already applied, but I found a few style items that still need attention (an em dash, meta-description length, inconsistent capitalization of "Global Volumes," and a missing |
- Remove em dash in intro (split into two sentences) - Expand meta description to 110-160 char range (was 71) - Use lowercase generic term 'global volume(s)' in prose, matching 'network volume' convention
|
I checked this PR against both the PROMPTLESS.md guidance and the Runpod style guide. Here's the result. Already passing: sentence-case headings, correct proper-noun casing (Runpod, Pods), bullets ending in periods, relative internal links, and the earlier reviewer requests to switch to Fixed and pushed to this branch:
One optional item I did not change: the Create, Attach, and Migrate procedures use plain numbered lists rather than the Mintlify Mount paths, UI labels, procedures, and technical claims were left unchanged. |
| Global volumes use object-backed storage, not a fully POSIX compliant file system. Review the following before using global volumes in production. | ||
|
|
||
| - **One volume of each type per Pod:** Each Pod currently supports a maximum of one global volume and one network volume at a time. | ||
| - **Not suitable for training writes:** Writing large volumes of data such as checkpoints, logs, and activations to a global volume during training is not supported. Use a network volume for workloads that write frequently. |
There was a problem hiding this comment.
Would rephrase:
- Not suitable for training writes: Writing large volumes of data to a global volume during training is not recommended. Use a network volume for workloads that write frequently.
| 2. Run the following command from the Pod's **Console** tab: | ||
|
|
||
| ```bash | ||
| rsync -avh /workspace/ /workspace-global/ |
There was a problem hiding this comment.
Maybe more readable?
rsync --archive --verbose --human-readable /workspace/ /workspace-global/
There was a problem hiding this comment.
@promtpless can you update the command like this :
rsync -avh /workspace/ /workspace-global/Where:
-a: copies all files and subdirectories, preserving timestamps, permissions, and symlinks-v: prints each file as it transfers-h: displays file sizes in a human-readable format (KB, MB, GB)
Mintlify-Source: dashboard-editor
|
Thanks for the review request — Promptless is looking into the docs.json change on this PR and will follow up shortly. |
|
Scoped the requested change — it's a small rephrase to one bullet on the storage/global volume page. Applying it on this branch now. |
Apply reviewer feedback on PR #746: drop the checkpoints/logs/activations examples and soften 'is not supported' to 'is not recommended' in the Not suitable for training writes bullet on the Global volumes page.
- Created storage/globalstore.mdx Mintlify-Source: dashboard-editor
|
On PR #746, we applied Murat's suggested rewrite to the "Not suitable for training writes" bullet on the Global volumes page: it now reads "Writing large volumes of data to a global volume during training is not recommended. Use a network volume for workloads that write frequently." (dropping the checkpoints/logs/activations examples and changing "is not supported" to "is not recommended"). Pushed to branch Note: Dave Seddon's separate |
# Conflicts: # release-notes.mdx
No description provided.