Skip to content

site: correct documentation on gitsshkey #3690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 2, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
site: correct documentation on gitsshkey
  • Loading branch information
ammario committed Aug 25, 2022
commit b940f5bfb915c260a64e2ad416abe8c23e6b93ef
10 changes: 8 additions & 2 deletions site/src/pages/UserSettingsPage/SSHKeysPage/SSHKeysPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@ import { SSHKeysPageView } from "./SSHKeysPageView"

export const Language = {
title: "SSH keys",
description:
"Coder automatically inserts a private key into every workspace; you can add the corresponding public key to any services (such as Git) that you need access to from your workspace.",
description: (
<p>
Git in workspaces is authenticated with the following public key. You may add it to Git
services (such as GitHub) that you need to access from your workspace. <br />
<br />
Coder sets <code>$GIT_SSH_COMMAND</code> to perform the override.
Copy link
Contributor

Choose a reason for hiding this comment

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

You haven't referenced an override yet so this could be more clear, like "to override ___"

</p>
),
regenerateDialogTitle: "Regenerate SSH key?",
regenerateDialogMessage:
"You will need to replace the public SSH key on services you use it with, and you'll need to rebuild existing workspaces.",
Expand Down