Skip to content

Commit 4377d01

Browse files
authored
Update guide link titles (#2316)
update guide links titles to match new guide titles on docs site
1 parent e8bf056 commit 4377d01

File tree

6 files changed

+26
-49
lines changed

6 files changed

+26
-49
lines changed

app/forms/instance-create.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ export function CreateInstanceForm() {
286286
heading="instances"
287287
icon={<Instances16Icon />}
288288
summary="Instances are virtual machines that run on the Oxide platform."
289-
links={[docLinks.instances, docLinks.vms, docLinks.quickStart]}
289+
links={[docLinks.instances, docLinks.instanceActions, docLinks.quickStart]}
290290
/>
291291
</PageHeader>
292292
<FullPageForm

app/pages/project/instances/InstancesPage.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export function InstancesPage() {
130130
heading="instances"
131131
icon={<Instances16Icon />}
132132
summary="Instances are virtual machines that run on the Oxide platform."
133-
links={[docLinks.instances, docLinks.vms]}
133+
links={[docLinks.instances, docLinks.instanceActions]}
134134
/>
135135
</PageHeader>
136136
<TableActions>

app/pages/project/instances/instance/InstancePage.tsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ export function InstancePage() {
140140
heading="instances"
141141
icon={<Instances16Icon />}
142142
summary="Instances are virtual machines that run on the Oxide platform."
143-
links={[docLinks.instances, docLinks.vms]}
143+
links={[docLinks.instances, docLinks.instanceActions]}
144144
/>
145145
<RefreshButton onClick={refreshData} />
146146
<MoreActionsMenu label="Instance actions" actions={actions} />

app/util/links.spec.ts

-20
This file was deleted.

app/util/links.ts

+22-25
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,18 @@
55
*
66
* Copyright Oxide Computer Company
77
*/
8-
export const links: Record<string, string> = {
8+
export const links = {
99
accessDocs: 'https://docs.oxide.computer/guides/configuring-access',
1010
cloudInitFormat: 'https://cloudinit.readthedocs.io/en/latest/explanation/format.html',
1111
cloudInitExamples: 'https://cloudinit.readthedocs.io/en/latest/reference/examples.html',
1212
disksDocs: 'https://docs.oxide.computer/guides/managing-disks-and-snapshots',
13-
externalAddresses:
14-
'https://docs.oxide.computer/guides/operator/ip-pool-management#_external_address_categorization',
1513
firewallRulesDocs:
1614
'https://docs.oxide.computer/guides/configuring-guest-networking#_firewall_rules',
1715
floatingIpsDocs: 'https://docs.oxide.computer/guides/managing-floating-ips',
1816
imagesDocs: 'https://docs.oxide.computer/guides/creating-and-sharing-images',
1917
preparingImagesDocs:
2018
'https://docs.oxide.computer/guides/creating-and-sharing-images#_preparing_images_for_import',
21-
instancesDocs: 'https://docs.oxide.computer/guides/managing-instances',
19+
instanceActionsDocs: 'https://docs.oxide.computer/guides/managing-instances',
2220
keyConceptsIamPolicyDocs:
2321
'https://docs.oxide.computer/guides/key-entities-and-concepts#iam-policy',
2422
keyConceptsProjectsDocs:
@@ -28,26 +26,25 @@ export const links: Record<string, string> = {
2826
sledDocs:
2927
'https://docs.oxide.computer/guides/architecture/service-processors#_server_sled',
3028
snapshotsDocs:
31-
'https://docs.oxide.computer/guides/managing-disks-and-snapshots#snapshots',
29+
'https://docs.oxide.computer/guides/managing-disks-and-snapshots#_snapshots',
3230
storageDocs:
33-
'https://docs.oxide.computer/guides/architecture/os-hypervisor-storage#_physical_layer',
31+
'https://docs.oxide.computer/guides/architecture/os-hypervisor-storage#_storage',
3432
systemIpPoolsDocs: 'https://docs.oxide.computer/guides/operator/ip-pool-management',
3533
systemMetricsDocs: 'https://docs.oxide.computer/guides/operator/system-metrics',
3634
systemSiloDocs: 'https://docs.oxide.computer/guides/operator/silo-management',
37-
vmsDocs:
38-
'https://docs.oxide.computer/guides/deploying-workloads#_creating_virtual_machines',
35+
instancesDocs: 'https://docs.oxide.computer/guides/deploying-workloads',
3936
vpcsDocs: 'https://docs.oxide.computer/guides/configuring-guest-networking',
4037
}
4138

4239
// These are links (and associated titles) to help documentation
4340
export const docLinks = {
4441
access: {
4542
href: links.accessDocs,
46-
linkText: 'Configuring Access and IAM',
43+
linkText: 'Access Control',
4744
},
4845
disks: {
4946
href: links.disksDocs,
50-
linkText: 'Managing Disks',
47+
linkText: 'Disks and Snapshots',
5148
},
5249
firewallRules: {
5350
href: links.firewallRulesDocs,
@@ -59,23 +56,23 @@ export const docLinks = {
5956
},
6057
keyConceptsIam: {
6158
href: links.keyConceptsIamPolicyDocs,
62-
linkText: 'Key Concepts: IAM Policy',
59+
linkText: 'Key Concepts',
6360
},
6461
images: {
6562
href: links.imagesDocs,
66-
linkText: 'Creating and Sharing Images',
63+
linkText: 'Images',
6764
},
68-
instances: {
69-
href: links.instancesDocs,
70-
linkText: 'Managing Instances',
65+
instanceActions: {
66+
href: links.instanceActionsDocs,
67+
linkText: 'Instance Actions',
7168
},
7269
keyConceptsProjects: {
7370
href: links.keyConceptsProjectsDocs,
74-
linkText: 'Key Concepts: Projects',
71+
linkText: 'Key Concepts',
7572
},
7673
projects: {
7774
href: links.projectsDocs,
78-
linkText: 'Managing Projects',
75+
linkText: 'Projects',
7976
},
8077
quickStart: {
8178
href: links.quickStart,
@@ -87,30 +84,30 @@ export const docLinks = {
8784
},
8885
snapshots: {
8986
href: links.snapshotsDocs,
90-
linkText: 'Managing Snapshots',
87+
linkText: 'Disks and Snapshots',
9188
},
9289
storage: {
9390
href: links.storageDocs,
9491
linkText: 'Storage',
9592
},
9693
systemIpPools: {
9794
href: links.systemIpPoolsDocs,
98-
linkText: 'IP Pool Management',
95+
linkText: 'IP Pools',
9996
},
10097
systemMetrics: {
10198
href: links.systemMetricsDocs,
102-
linkText: 'System Metrics',
99+
linkText: 'Metrics',
103100
},
104101
systemSilo: {
105102
href: links.systemSiloDocs,
106-
linkText: 'Silo Management',
103+
linkText: 'Silos',
107104
},
108-
vms: {
109-
href: links.vmsDocs,
110-
linkText: 'Deploying Workloads',
105+
instances: {
106+
href: links.instancesDocs,
107+
linkText: 'Instances',
111108
},
112109
vpcs: {
113110
href: links.vpcsDocs,
114-
linkText: 'VPCs and Subnets',
111+
linkText: 'Networking',
115112
},
116113
}

test/e2e/docs-popover.e2e.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { expect, test } from './utils'
99

1010
test('Show / hide contextual help docs links', async ({ page }) => {
1111
const learnAbout = page.getByText('Learn about disks')
12-
const managingDisksLink = page.getByRole('link', { name: 'Managing Disks' })
12+
const managingDisksLink = page.getByRole('link', { name: 'Disks and Snapshots' })
1313

1414
await page.goto('/projects/mock-project/disks')
1515

0 commit comments

Comments
 (0)