Skip to content

Commit b6ed375

Browse files
authored
Add docs popover for SSH Keys (#2370)
1 parent af6c1f4 commit b6ed375

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

app/pages/settings/SSHKeysPage.tsx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import { Link, Outlet, useNavigate } from 'react-router-dom'
1212
import { apiQueryClient, useApiMutation, useApiQueryClient, type SshKey } from '@oxide/api'
1313
import { Key16Icon, Key24Icon } from '@oxide/design-system/icons/react'
1414

15+
import { DocsPopover } from '~/components/DocsPopover'
1516
import { confirmDelete } from '~/stores/confirm-delete'
1617
import { addToast } from '~/stores/toast'
1718
import { useColsWithActions, type MenuAction } from '~/table/columns/action-col'
@@ -21,6 +22,7 @@ import { buttonStyle } from '~/ui/lib/Button'
2122
import { EmptyMessage } from '~/ui/lib/EmptyMessage'
2223
import { PageHeader, PageTitle } from '~/ui/lib/PageHeader'
2324
import { TableActions } from '~/ui/lib/Table'
25+
import { docLinks } from '~/util/links'
2426
import { pb } from '~/util/path-builder'
2527

2628
SSHKeysPage.loader = async () => {
@@ -79,6 +81,12 @@ export function SSHKeysPage() {
7981
<>
8082
<PageHeader>
8183
<PageTitle icon={<Key24Icon />}>SSH Keys</PageTitle>
84+
<DocsPopover
85+
heading="SSH keys"
86+
icon={<Key16Icon />}
87+
summary="SSH keys are used to securely access VM instances."
88+
links={[docLinks.sshKeys]}
89+
/>
8290
</PageHeader>
8391
<TableActions>
8492
<Link className={buttonStyle({ size: 'sm' })} to={pb.sshKeysNew()}>

app/util/links.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export const links = {
2727
'https://docs.oxide.computer/guides/architecture/service-processors#_server_sled',
2828
snapshotsDocs:
2929
'https://docs.oxide.computer/guides/managing-disks-and-snapshots#_snapshots',
30+
sshKeysDocs: 'https://docs.oxide.computer/guides/user-settings#_ssh_keys',
3031
storageDocs:
3132
'https://docs.oxide.computer/guides/architecture/os-hypervisor-storage#_storage',
3233
systemIpPoolsDocs: 'https://docs.oxide.computer/guides/operator/ip-pool-management',
@@ -86,6 +87,10 @@ export const docLinks = {
8687
href: links.snapshotsDocs,
8788
linkText: 'Disks and Snapshots',
8889
},
90+
sshKeys: {
91+
href: links.sshKeysDocs,
92+
linkText: 'SSH Keys',
93+
},
8994
storage: {
9095
href: links.storageDocs,
9196
linkText: 'Storage',

0 commit comments

Comments
 (0)