Skip to content

Create SSH-key-management.mdx - #748

Open
lavanya-gunreddi wants to merge 34 commits into
mainfrom
lg-ssh-480
Open

lavanya-gunreddi wants to merge 34 commits into
mainfrom
lg-ssh-480

Conversation

@lavanya-gunreddi

@lavanya-gunreddi lavanya-gunreddi commented Jul 29, 2026 •

Copy link
Copy Markdown
Contributor

Part of DOCS-480

Style-guide + promptless.md pass (per @lavanya-gunreddi request)

Applied the Runpod style guide and promptless.md rules across the files changed in this branch. Disposition per reviewer item:

  • docs.json invalid JSON (critical, review 2): applied verbatim — the missing comma was already fixed on the branch; this pass additionally re-indented the Organizations pages array to match its siblings and pointed the nav entry at the lowercase file.
  • Filename not kebab-case (medium): applied verbatim — renamed SSH-key-management.mdx → ssh-key-management.mdx; updated docs.json and the overview link to the lowercase path.
  • overview.mdx casing (low): "Use Pods, endpoints, network volumes, and Instant Clusters": applied verbatim — pods→Pods, Endpoints→endpoints, Network Volumes→network volumes, Clusters→Instant Clusters.
  • Em-dash separators (style guide): applied — replaced the em dashes separating the three bolded labels from their descriptions in overview.mdx with colons.
  • Meta descriptions under 110 chars (style guide): applied — expanded overview.mdx (68→145) and resource-tagging.mdx (89→156) to the required 110–160 range.
  • org → organization in prose (style guide): applied in overview.mdx.

Not addressed in this style pass (out of scope — flagged for a human/factual follow-up)

This pass covered style and formatting only. The following review items are factual/content changes and were left for a separate pass:

  • The [CONFIRM: ...] author note at overview.mdx:21 (Settings → Organization path) — an unverified UI-path claim.
  • overview.mdx "SSH key management" bullet still says keys are stored "at the organization level"/"without individual key setup"; the SSH page was corrected to the per-member model, but the landing-page summary wording is a factual edit, not a style one.
  • resource-tagging.mdx availability wording (Organizations-only), the "tag value optional" vs "can be left blank" correction, sidebarTitle/title alignment, and the tag: "NEW" badge consistency.
  • roles-and-permissions.mdx being Teams content in the Organizations nav group; team vs org role differences on the SSH page; the DOCS-480 cross-link from pods/configuration/use-ssh.mdx.

SSH key injection pass (requested in #topic-documentation)

Open in Promptless

Documents SSH key injection and sync from POD-144 on the SSH key management page. Runpod keeps each Pod's /root/.ssh/authorized_keys in sync with members' account settings, so key additions, deletions, and membership changes reach running Pods (usually within a minute) without a redeploy. The page now covers proxied SSH vs. SSH via public IP timing, who receives keys on personal and organization Pods, that the platform manages the whole authorized_keys file and ignores PUBLIC_KEY/RUNPOD_SSH_PUBLIC_KEY, that Serverless workers are excluded, and the limits of revocation. This replaces the earlier "keys are frozen at Pod creation" guidance throughout, including troubleshooting and security notes.

Also updated to match: pods/configuration/use-ssh.mdx (the env-var override section) and pods/configuration/connect-to-ide.mdx (the warning that told readers to append keys to authorized_keys manually).

Points for a reviewer to confirm with the Pods team: the organization visibility rule (creator, group members, and admins by default; all members in orgs where everyone sees all resources) was still awaiting confirmation on POD-144.

Trigger events

@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 Oct 20, 2026, 9:17 PM

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

@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 (UTC)
runpod-docs 🟡 Building – Jul 29, 2026, 9:37 PM

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

Comment thread accounts-billing/organizations/ssh-key-management.mdx Outdated
Comment thread accounts-billing/organizations/ssh-key-management.mdx
@promptless

promptless Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

In reply to this discussion

Done — the style-guide and promptless.md fixes have been applied and pushed to this branch (PR #748). That includes the kebab-case rename of the SSH key page with its nav and link updates, em-dash separators replaced with colons, term casing corrected (Pods, endpoints, network volumes, Instant Clusters), "org" spelled out to "organization", and two meta descriptions expanded to the required length.

@promptless

promptless Bot commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

In reply to this discussion

Done — I applied the Runpod style guide and promptless.md rules across all six files changed in this branch and pushed the result to PR #748. That included renaming the SSH page to lowercase kebab-case (ssh-key-management.mdx) with its nav and link updates, tidying the docs.json Organizations nav indentation, replacing em-dash separators with colons, correcting term casing (Pods; lowercase endpoints and network volumes; Instant Clusters), spelling out "org" as "organization", and expanding two page descriptions to the required 110–160 characters. These were style-and-formatting changes only.

A few of rambo-runpod's review comments are factual/content items rather than style — for example the overview page still describing the old org-level key store, the roles-and-permissions.mdx team-vs-org scoping, the resource-tagging availability and "tag value can be left blank" wording, and the missing DOCS-480 cross-link in pods/configuration/use-ssh.mdx. Let me know if you'd like those handled in a separate content pass.

Review: https://app.gopromptless.ai/suggestions/5c3954b9-ec0d-4b08-9f30-6441a7e95bfc

Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread accounts-billing/organizations/ssh-key-management.mdx
Comment thread pods/configuration/use-ssh.mdx
Comment thread pods/configuration/connect-to-ide.mdx

This branch was successfully deployed

1 active deployment
staging — 4d89e3cf Deployed Oct 20, 2026 by mintlify[bot]
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.

2 participants