Repository navigation
Create SSH-key-management.mdx - #748
lavanya-gunreddi wants to merge 34 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
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. |
|
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 ( 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 Review: https://app.gopromptless.ai/suggestions/5c3954b9-ec0d-4b08-9f30-6441a7e95bfc |
# Conflicts: # docs.json
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.jsoninvalid JSON (critical, review 2): applied verbatim — the missing comma was already fixed on the branch; this pass additionally re-indented the Organizationspagesarray to match its siblings and pointed the nav entry at the lowercase file.SSH-key-management.mdx→ssh-key-management.mdx; updateddocs.jsonand the overview link to the lowercase path.overview.mdxcasing (low): "Use Pods, endpoints, network volumes, and Instant Clusters": applied verbatim —pods→Pods,Endpoints→endpoints,Network Volumes→network volumes,Clusters→Instant Clusters.overview.mdxwith colons.overview.mdx(68→145) andresource-tagging.mdx(89→156) to the required 110–160 range.org→organizationin prose (style guide): applied inoverview.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:
[CONFIRM: ...]author note atoverview.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.mdxavailability wording (Organizations-only), the "tag value optional" vs "can be left blank" correction,sidebarTitle/title alignment, and thetag: "NEW"badge consistency.roles-and-permissions.mdxbeing Teams content in the Organizations nav group; team vs org role differences on the SSH page; the DOCS-480 cross-link frompods/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_keysin 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 wholeauthorized_keysfile and ignoresPUBLIC_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) andpods/configuration/connect-to-ide.mdx(the warning that told readers to append keys toauthorized_keysmanually).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