Skip to content

Commit 4d1215e

Browse files
authored
Update docs links (#3371)
This updates a few links (both to docs.oxide.computer URLs and to a couple of external URLs). Nothing major. Also one label change, where the "Metrics" link label now reads **"Utilization"**, as A. the page linking to it is now called "Utilization" and B. the docs themselves are now titled "Calculating Utilization"
1 parent 7b434ba commit 4d1215e

2 files changed

Lines changed: 13 additions & 15 deletions

File tree

‎app/components/form/fields/SshKeysField.tsx‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import { Message } from '~/ui/lib/Message'
2222
import { TextInputHint } from '~/ui/lib/TextInput'
2323
import { isSubset } from '~/util/array'
2424
import { ALL_ISH } from '~/util/consts'
25+
import { links } from '~/util/links'
2526

2627
import { CheckboxField } from './CheckboxField'
2728
import { ErrorMessage } from './ErrorMessage'
@@ -36,11 +37,7 @@ const CloudInitMessage = () => (
3637
content={
3738
<>
3839
If your image supports the cidata volume and{' '}
39-
<a
40-
target="_blank"
41-
href="https://cloudinit.readthedocs.io/en/latest/"
42-
rel="noreferrer"
43-
>
40+
<a target="_blank" href={links.cloudInit} rel="noreferrer">
4441
cloud-init
4542
</a>
4643
, the keys above will be added to your instance. Keys are added when the instance is

‎app/util/links.ts‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,9 @@ const remoteAccess = 'https://docs.oxide.computer/guides/remote-access'
1111
// URLs used in inline prose links where the label is chosen to fit the
1212
// surrounding sentence. For links with a canonical label, use docLinks instead.
1313
export const links = {
14-
cloudInitFormat: 'https://cloudinit.readthedocs.io/en/latest/explanation/format.html',
15-
cloudInitExamples: 'https://cloudinit.readthedocs.io/en/latest/reference/examples.html',
14+
cloudInit: 'https://docs.cloud-init.io/',
15+
cloudInitFormat: 'https://docs.cloud-init.io/en/latest/explanation/format.html',
16+
cloudInitExamples: 'https://docs.cloud-init.io/en/latest/reference/examples.html',
1617
firewallRulesDocs:
1718
'https://docs.oxide.computer/guides/configuring-guest-networking#_firewall_rules',
1819
preparingImagesDocs:
@@ -45,7 +46,7 @@ export const docLinks = {
4546
linkText: 'Audit Log',
4647
},
4748
deviceTokens: {
48-
href: 'https://docs.oxide.computer/guides/working-with-api-and-sdk#_device_token_setup',
49+
href: 'https://docs.oxide.computer/guides/user-settings#_access_tokens',
4950
linkText: 'Access Tokens',
5051
},
5152
externalSubnets: {
@@ -93,7 +94,7 @@ export const docLinks = {
9394
linkText: 'Instance Actions',
9495
},
9596
oxql: {
96-
href: 'https://docs.oxide.computer/guides/operator/system-metrics#_oxql_quickstart',
97+
href: 'https://docs.oxide.computer/guides/metrics/oxql-tutorial#_oxql_quick_start',
9798
linkText: 'OxQL',
9899
},
99100
keyConceptsProjects: {
@@ -117,7 +118,7 @@ export const docLinks = {
117118
linkText: 'Resource Management',
118119
},
119120
scim: {
120-
href: 'https://docs.oxide.computer/guides/operator/identity-providers#_saml_authentication_scim_user_provisioning',
121+
href: 'https://docs.oxide.computer/guides/operator/identity-providers#scim',
121122
linkText: 'SCIM',
122123
},
123124
serialConsole: {
@@ -133,7 +134,7 @@ export const docLinks = {
133134
linkText: 'VPC Subnet Routing',
134135
},
135136
sleds: {
136-
href: 'https://docs.oxide.computer/guides/architecture/service-processors#_server_sled',
137+
href: 'https://docs.oxide.computer/guides/architecture/rack-components#_server_sled',
137138
linkText: 'Server Sleds',
138139
},
139140
snapshots: {
@@ -145,7 +146,7 @@ export const docLinks = {
145146
linkText: 'SSH',
146147
},
147148
sshKeys: {
148-
href: 'https://docs.oxide.computer/guides/user-settings#_ssh_keys',
149+
href: 'https://docs.oxide.computer/guides/user-settings#manage-ssh-keys',
149150
linkText: 'SSH Keys',
150151
},
151152
storage: {
@@ -161,11 +162,11 @@ export const docLinks = {
161162
linkText: 'Subnet Pools',
162163
},
163164
systemMetrics: {
164-
href: 'https://docs.oxide.computer/guides/operator/system-metrics',
165-
linkText: 'Metrics',
165+
href: 'https://docs.oxide.computer/guides/operator/resource-management#_calculating_utilization',
166+
linkText: 'Utilization',
166167
},
167168
systemSiloCreate: {
168-
href: 'https://docs.oxide.computer/guides/system/completing-rack-config#_create_silo',
169+
href: 'https://docs.oxide.computer/guides/system/completing-rack-config#_create_a_silo',
169170
linkText: 'Create Silo',
170171
},
171172
systemSilo: {

0 commit comments

Comments
 (0)