Skip to content
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

Update guide link titles #2316

Merged
merged 1 commit into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion app/forms/instance-create.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ export function CreateInstanceForm() {
heading="instances"
icon={<Instances16Icon />}
summary="Instances are virtual machines that run on the Oxide platform."
links={[docLinks.instances, docLinks.vms, docLinks.quickStart]}
links={[docLinks.instances, docLinks.instanceActions, docLinks.quickStart]}
/>
</PageHeader>
<FullPageForm
Expand Down
2 changes: 1 addition & 1 deletion app/pages/project/instances/InstancesPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ export function InstancesPage() {
heading="instances"
icon={<Instances16Icon />}
summary="Instances are virtual machines that run on the Oxide platform."
links={[docLinks.instances, docLinks.vms]}
links={[docLinks.instances, docLinks.instanceActions]}
/>
</PageHeader>
<TableActions>
Expand Down
2 changes: 1 addition & 1 deletion app/pages/project/instances/instance/InstancePage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ export function InstancePage() {
heading="instances"
icon={<Instances16Icon />}
summary="Instances are virtual machines that run on the Oxide platform."
links={[docLinks.instances, docLinks.vms]}
links={[docLinks.instances, docLinks.instanceActions]}
/>
<RefreshButton onClick={refreshData} />
<MoreActionsMenu label="Instance actions" actions={actions} />
Expand Down
20 changes: 0 additions & 20 deletions app/util/links.spec.ts

This file was deleted.

47 changes: 22 additions & 25 deletions app/util/links.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,18 @@
*
* Copyright Oxide Computer Company
*/
export const links: Record<string, string> = {
export const links = {
accessDocs: 'https://docs.oxide.computer/guides/configuring-access',
cloudInitFormat: 'https://cloudinit.readthedocs.io/en/latest/explanation/format.html',
cloudInitExamples: 'https://cloudinit.readthedocs.io/en/latest/reference/examples.html',
disksDocs: 'https://docs.oxide.computer/guides/managing-disks-and-snapshots',
externalAddresses:
'https://docs.oxide.computer/guides/operator/ip-pool-management#_external_address_categorization',
firewallRulesDocs:
'https://docs.oxide.computer/guides/configuring-guest-networking#_firewall_rules',
floatingIpsDocs: 'https://docs.oxide.computer/guides/managing-floating-ips',
imagesDocs: 'https://docs.oxide.computer/guides/creating-and-sharing-images',
preparingImagesDocs:
'https://docs.oxide.computer/guides/creating-and-sharing-images#_preparing_images_for_import',
instancesDocs: 'https://docs.oxide.computer/guides/managing-instances',
instanceActionsDocs: 'https://docs.oxide.computer/guides/managing-instances',
keyConceptsIamPolicyDocs:
'https://docs.oxide.computer/guides/key-entities-and-concepts#iam-policy',
keyConceptsProjectsDocs:
Expand All @@ -28,26 +26,25 @@ export const links: Record<string, string> = {
sledDocs:
'https://docs.oxide.computer/guides/architecture/service-processors#_server_sled',
snapshotsDocs:
'https://docs.oxide.computer/guides/managing-disks-and-snapshots#snapshots',
'https://docs.oxide.computer/guides/managing-disks-and-snapshots#_snapshots',
storageDocs:
'https://docs.oxide.computer/guides/architecture/os-hypervisor-storage#_physical_layer',
'https://docs.oxide.computer/guides/architecture/os-hypervisor-storage#_storage',
systemIpPoolsDocs: 'https://docs.oxide.computer/guides/operator/ip-pool-management',
systemMetricsDocs: 'https://docs.oxide.computer/guides/operator/system-metrics',
systemSiloDocs: 'https://docs.oxide.computer/guides/operator/silo-management',
vmsDocs:
'https://docs.oxide.computer/guides/deploying-workloads#_creating_virtual_machines',
instancesDocs: 'https://docs.oxide.computer/guides/deploying-workloads',
vpcsDocs: 'https://docs.oxide.computer/guides/configuring-guest-networking',
}

// These are links (and associated titles) to help documentation
export const docLinks = {
access: {
href: links.accessDocs,
linkText: 'Configuring Access and IAM',
linkText: 'Access Control',
},
disks: {
href: links.disksDocs,
linkText: 'Managing Disks',
linkText: 'Disks and Snapshots',
},
firewallRules: {
href: links.firewallRulesDocs,
Expand All @@ -59,23 +56,23 @@ export const docLinks = {
},
keyConceptsIam: {
href: links.keyConceptsIamPolicyDocs,
linkText: 'Key Concepts: IAM Policy',
linkText: 'Key Concepts',
},
images: {
href: links.imagesDocs,
linkText: 'Creating and Sharing Images',
linkText: 'Images',
},
instances: {
href: links.instancesDocs,
linkText: 'Managing Instances',
instanceActions: {
href: links.instanceActionsDocs,
linkText: 'Instance Actions',
},
keyConceptsProjects: {
href: links.keyConceptsProjectsDocs,
linkText: 'Key Concepts: Projects',
linkText: 'Key Concepts',
},
projects: {
href: links.projectsDocs,
linkText: 'Managing Projects',
linkText: 'Projects',
},
quickStart: {
href: links.quickStart,
Expand All @@ -87,30 +84,30 @@ export const docLinks = {
},
snapshots: {
href: links.snapshotsDocs,
linkText: 'Managing Snapshots',
linkText: 'Disks and Snapshots',
},
storage: {
href: links.storageDocs,
linkText: 'Storage',
},
systemIpPools: {
href: links.systemIpPoolsDocs,
linkText: 'IP Pool Management',
linkText: 'IP Pools',
},
systemMetrics: {
href: links.systemMetricsDocs,
linkText: 'System Metrics',
linkText: 'Metrics',
},
systemSilo: {
href: links.systemSiloDocs,
linkText: 'Silo Management',
linkText: 'Silos',
},
vms: {
href: links.vmsDocs,
linkText: 'Deploying Workloads',
instances: {
href: links.instancesDocs,
linkText: 'Instances',
},
vpcs: {
href: links.vpcsDocs,
linkText: 'VPCs and Subnets',
linkText: 'Networking',
},
}
2 changes: 1 addition & 1 deletion test/e2e/docs-popover.e2e.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { expect, test } from './utils'

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

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

Expand Down
Loading