Skip to content

Update docs.json - #746

Merged
lavanya-gunreddi merged 34 commits into
mainfrom
lg-global-store-477
Sep 15, 2026
Merged

lavanya-gunreddi merged 34 commits into
mainfrom
lg-global-store-477

Conversation

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor

No description provided.

@mintlify

mintlify Bot commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Sep 15, 2026, 12:46 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

Comment thread storage/globalstore.mdx Outdated

## Limitations

Global volumes use object-backed storage, not a POSIX file system. Review the following before using global volumes in production.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

not a POSIX file system -> not a fully POSIX compliant file system

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@Promptless apply this comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Done — updated to "not a fully POSIX compliant file system." Pushed to this branch in commit 4053e32.

Comment thread storage/globalstore.mdx Outdated
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

No POSIX semantics
-> Limited POSIX semantics

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@Promptless Apply this comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Done — the label now reads "Limited POSIX semantics." Pushed to this branch in commit 4053e32.

Comment thread storage/globalstore.mdx Outdated
- **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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Object consistency -> "Eventual consistency"

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@Promptless apply this comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Done — the label now reads "Eventual consistency." Pushed to this branch in commit 4053e32.

@promptless

promptless Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

On it — applying the requested wording changes to storage/globalstore.mdx on this branch now. I'll follow up here once the updates are pushed.

@lavanya-gunreddi

Copy link
Copy Markdown
Contributor Author

@Promptless can you do a final check if we have applied all the rules from promptless.md file and runpod style guide

@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

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.

@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

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 <Steps> component that sibling storage pages use). I'm confirming the details and will follow up with the specifics.

- 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
@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

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 /workspace-global (all applied in 5082c66). The docs.json nav entry is clean.

Fixed and pushed to this branch:

  • Removed an em dash from the intro paragraph (the style guide prohibits em dashes) and split it into two sentences.
  • Expanded the meta description from 71 to 145 characters to fall within the required 110–160 range.
  • Lowercased "global volume(s)" in prose where it was inconsistently title-cased, to match how the guide treats the generic term "network volume." UI labels like the Global volume storage-type option were left capitalized.

One optional item I did not change: the Create, Attach, and Migrate procedures use plain numbered lists rather than the Mintlify <Steps> component that the procedural pattern recommends, and there's no "Requirements" section. I left this as a judgment call — the sibling storage pages mix both styles and your reviewers already approved the structure — but flagging it in case you'd like to adopt <Steps> here for consistency.

Mount paths, UI labels, procedures, and technical claims were left unchanged.

Comment thread storage/globalvolume.mdx Outdated
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@Promptless work on this comment

Comment thread storage/globalvolume.mdx
2. Run the following command from the Pod's **Console** tab:

```bash
rsync -avh /workspace/ /workspace-global/

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe more readable?

rsync --archive --verbose --human-readable /workspace/ /workspace-global/

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@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)

@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Thanks for the review request — Promptless is looking into the docs.json change on this PR and will follow up shortly.

@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

Scoped the requested change — it's a small rephrase to one bullet on the storage/global volume page. Applying it on this branch now.

promptless Bot and others added 2 commits September 14, 2026 21:46
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
@promptless

promptless Bot commented Sep 14, 2026

Copy link
Copy Markdown
Contributor

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 lg-global-store-477 in commit 8865ec1.

Note: Dave Seddon's separate rsync readability comment (line 67) wasn't tagged for us and wasn't part of this request, so it's untouched — let us know if you'd like that applied too.

@lavanya-gunreddi
lavanya-gunreddi merged commit ceb7997 into main Sep 15, 2026
4 checks passed
@lavanya-gunreddi
lavanya-gunreddi deleted the lg-global-store-477 branch September 15, 2026 16:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants