Skip to content

Commit 65dd900

Browse files
authored
Fix copy and add missing links in help panels (#183)
1 parent 80335b6 commit 65dd900

File tree

6 files changed

+66
-63
lines changed

6 files changed

+66
-63
lines changed

frontend/locales/en/strings.json

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
"details": "Details",
106106
"instances": "Instances",
107107
"storage": "Storage",
108-
"scheduling": "Job scheduling",
108+
"scheduling": "Job status",
109109
"accounting": "Accounting",
110110
"stackEvents": "Stack events"
111111
},
@@ -166,20 +166,20 @@
166166
}
167167
},
168168
"storage": {
169-
"tableTitle":"Filesystems",
169+
"tableTitle":"File systems",
170170
"id": "ID",
171171
"mountPath": "Mount path",
172172
"name": "Name",
173173
"type": "Type",
174-
"noFilesystems": "No filesystems to display",
175-
"noFilesystemsFound": "No filesystems found.",
176-
"noFilesystemsToDisplay": "Edit the cluster to add the storage of your choice.",
174+
"noFilesystems": "No file systems to display",
175+
"noFilesystemsFound": "No file systems found.",
176+
"noFilesystemsToDisplay": "Edit the cluster to add file systems.",
177177
"filter": {
178-
"loading": "Loading Filesystems...",
179-
"filteringPlaceholder": "Find filesystems",
180-
"filteringAriaLabel": "Find filesystems",
178+
"loading": "Loading file systems...",
179+
"filteringPlaceholder": "Find file systems",
180+
"filteringAriaLabel": "Find file systems",
181181
"noMatches": "No matches",
182-
"noFilesystems": "No filesystems match the filters.",
182+
"noFilesystems": "No file systems match the filters.",
183183
"clear": "Clear filter"
184184
}
185185
},
@@ -209,7 +209,7 @@
209209
"filter": {
210210
"empty": {
211211
"title": "No jobs to display",
212-
"subtitle": "Schedule a job on the cluster to monitor its status."
212+
"subtitle": "From the cluster head node, submit a job and monitor its status."
213213
}
214214
}
215215
},
@@ -230,7 +230,7 @@
230230
"filteringPlaceholder": "Find jobs",
231231
"empty": {
232232
"title": "No jobs to display",
233-
"subtitle": "Schedule a job on the cluster to monitor its status."
233+
"subtitle": "From the cluster head node, submit a job and monitor its status."
234234
}
235235
},
236236
"loadingJobs": "Loading jobs...",
@@ -240,14 +240,13 @@
240240
"label": "Select a log stream from the left."
241241
},
242242
"help": {
243-
"main": "<p><strong>Create</strong> a new cluster or select a listed cluster to view detailed information. You can also choose <strong>Stop fleet</strong> or <strong>Start fleet</strong> to stop or start the cluster compute fleet, and <strong>Edit</strong> or <strong>Delete</strong> a selected cluster.</p><p>You can only <strong>Create</strong> and <strong>Edit</strong> clusters with the same AWS ParallelCluster version that was used to create the $t(global.projectName).</p><p>Depending on the cluster configuration, you can use an AWS Systems Manager shell session or a DCV virtual desktop to access the head node of the selected cluster. You can also access the file system of the selected cluster.</p><p>Enter text in the search field to find clusters by name, status, or version.</p>Select a listed cluster to view its details.<0></0><p>Choose <strong>Create</strong> to create and configure a cluster.</p>Choose <strong>Edit</strong> to update the cluster configuration. Some configuration updates require that you first stop the compute fleet, and some updates can't be performed.",
244-
"details": "<strong>Details</strong> shows a summary of cluster properties, starting with a link to the CloudFormation stack that created your cluster.To connect to the head node instance, use the link provided by the <strong>EC2 Instance Connect</strong> helper.",
243+
"main": "<p>Create a new cluster or select a listed cluster to view detailed information.</p><p>Choose <strong>Create cluster</strong> to create and configure a cluster. Choose <strong>Step by step</strong> to create a cluster by using the widget only. Choose <strong>With a template</strong> if you want to choose a template to populate the wizard before you start. Choose <strong>With an existing cluster</strong> if you want to choose and existing cluster to populate the wizard before you start.</p><p>Choose <strong>Actions</strong>, <strong>Edit cluster</strong> to update the cluster configuration. Some configuration updates require that you first stop the compute fleet, and some updates can't be performed.</p><p>You can toggle <strong>Stop fleet</strong> | <strong>Start fleet</strong> to stop or start the cluster compute fleet. Choose <strong>Actions</strong> to <strong>Delete cluster</strong>.</p><p>You can only <strong>Create</strong> and <strong>Edit</strong> clusters with the same AWS ParallelCluster version that was used to create the AWS ParallelCluster UI.</p><p>Depending on the cluster configuration, you can use an AWS Systems Manager shell session or a DCV virtual desktop to access the head node of the selected cluster. From <strong>Actions</strong>, choose <strong>View file system</strong> to navigate to the cluster file system in the AWS management console, or choose <strong>View logs</strong> to view AWS ParallelCluster logs.</p><p>Enter text in the search field to find clusters by name, status, or version. Select a listed cluster to view its details.</p><0></0>",
244+
"details": "<strong>Details</strong> shows a summary of cluster properties. To connect to the head node instance, use the link provided by the <strong>EC2 Instance Connect</strong> helper.",
245245
"instances": "<strong>Instances</strong> shows the list of cluster EC2 instances.",
246246
"storage": "<strong>Storage</strong> shows the list of your configured file systems.",
247247
"scheduling": "<strong>Job scheduling</strong> shows running jobs.",
248-
"accounting": "<strong>Accounting</strong> is a dashboard for your configured Slurm accounting data.",
248+
"accounting": "<strong>Accounting</strong> shows a dashboard for your configured Slurm accounting data.",
249249
"events": "<strong>Stack events</strong> shows the record of cluster CloudFormation stack create, update, and delete events.",
250-
"logs": "<strong>Logs</strong> shows the AWS ParallelCluster logs created for your cluster.",
251250
"dcvLink": {
252251
"title": "NICE DCV",
253252
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/dcv-v3.html?icmpid=docs_parallelcluster_hp_clusters_v1"
@@ -474,7 +473,7 @@
474473
},
475474
"clusterName": {
476475
"label": "Name",
477-
"description": "The name must start with an alphabetical character. Valid characters: A-Z, a-z, 0-9, and - (hyphen).",
476+
"description": "The name must start with an alphabetical character and can have up to 60 characters. If Slurm accounting is configured, the name can have up to 40 characters. Valid characters: A-Z, a-z, 0-9, and - (hyphen).",
478477
"placeholder": "Enter your cluster name",
479478
"cannotBeBlank": "Cluster name must not be blank.",
480479
"alreadyExists": "Cluster with name {{clusterName}} already exists. Choose a unique name.",
@@ -601,18 +600,14 @@
601600
"title": "What are custom actions?",
602601
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/custom-bootstrap-actions-v3.html?icmpid=docs_parallelcluster_hp_headnode_v1"
603602
},
604-
"slurmSettings": "<p>Configure Slurm accounting settings and queue update strategy settings for your cluster.</p><p>Choose <strong>Refresh</strong> to view recently changed or added AWS resources.</p>",
603+
"slurmSettings": "<p>Configure Slurm accounting settings for your cluster.</p><p>Choose <strong>Refresh</strong> to view recently changed or added AWS resources.</p>",
605604
"accountingLink": {
606605
"title": "How Slurm accounting works with AWS ParallelCluster",
607606
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/slurm-accounting-v3.html?icmpid=docs_parallelcluster_hp_headnode_accounting_v1"
608607
},
609608
"databaseLink": {
610609
"title": "Slurm accounting database setting",
611610
"href": "https://alpha.www.docs.aws.a2z.com/parallelcluster/latest/ug/Scheduling-v3.html#Scheduling-v3-SlurmSettings-Database"
612-
},
613-
"queueLink": {
614-
"title": "Queue update strategy setting",
615-
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-QueueUpdateStrategy"
616611
}
617612
},
618613
"validation": {
@@ -637,12 +632,16 @@
637632
},
638633
"keypair": {
639634
"label": "Key pair",
640-
"description": "Choose a key pair to connect the head node by using SSH."
635+
"description": "Choose a key pair to connect to the head node by using SSH."
641636
},
642637
"imdsSecured": {
643638
"label": "IMDS",
644639
"set": "Set IMDS secured",
645-
"help": "IMDS secured restricts access to IMDS (and thus instance credentials) to users with superuser permissions. For more information, see <0>How instance metadata service version 2 works</0> in the <i>Amazon EC2 User Guide for Linux Instances</i>."
640+
"help": "IMDS secured restricts access to IMDS (and thus instance credentials) to users with superuser permissions.",
641+
"imdsv2Link": {
642+
"title": "How instance metadata service version 2 works",
643+
"href": "https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html#instance-metadata-v2-how-it-works"
644+
}
646645
},
647646
"networking": {
648647
"header": "Networking",
@@ -656,7 +655,6 @@
656655
},
657656
"securityGroups": {
658657
"label": "Additional security groups",
659-
"help": "Select one or more security groups.",
660658
"select": "Select one or more security groups"
661659
},
662660
"localStorage": {
@@ -810,7 +808,11 @@
810808
},
811809
"compression": {
812810
"label": "Compress file system data",
813-
"help": "When data compression is used, Amazon FSx for Lustre automatically compresses newly written files before they are written to disk and automatically uncompresses them when they are read. See <0>DataCompressionType</0>."
811+
"help": "When data compression is used, Amazon FSx for Lustre automatically compresses newly written files before they are written to disk and automatically uncompresses them when they are read.",
812+
"link": {
813+
"title": "DataCompressionType setting",
814+
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/SharedStorage-v3.html#yaml-SharedStorage-FsxLustreSettings-DataCompressionType"
815+
}
814816
}
815817
},
816818
"Efs": {
@@ -960,14 +962,18 @@
960962
"slurmMemorySettings": {
961963
"container": {
962964
"title": "Slurm settings",
963-
"help": "<p>Use Slurm memory-based scheduling to specify the amount of memory per node required by a job with Slurm's --mem parameter.</p><p>Choose <strong>Refresh</strong> to view recently changed or added AWS resources.</p>",
965+
"help": "<p>Use Slurm memory-based scheduling to specify the amount of memory per node required by a job with Slurm's <code>--mem</code> parameter.</p><p>Choose a queue update strategy.</p><p>Choose <strong>Refresh</strong> to view recently changed or added AWS resources.</p>",
964966
"memorySchedulingLink": {
965967
"title": "How Slurm memory-based scheduling works with AWS ParallelCluster",
966968
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/slurm-mem-based-scheduling-v3.html?icmpid=docs_parallelcluster_hp_queues_slurm_memory_v1"
967969
},
968970
"schedulingPropertiesLink": {
969971
"title": "Slurm memory-based scheduling setting",
970972
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-EnableMemoryBasedScheduling"
973+
},
974+
"queueUpdateStrategyLink": {
975+
"title": "Queue update strategy setting",
976+
"href": "https://docs.aws.amazon.com/parallelcluster/latest/ug/Scheduling-v3.html#yaml-Scheduling-SlurmSettings-QueueUpdateStrategy"
971977
}
972978
},
973979
"toggle": {
@@ -1160,7 +1166,7 @@
11601166
"users": {
11611167
"header": {
11621168
"title": "Users",
1163-
"description": "The list of users that have permission to access the AWS ParallelCluster User Interface."
1169+
"description": "The list of users that have permission to access the AWS ParallelCluster UI."
11641170
},
11651171
"actions": {
11661172
"add": "Add user",

frontend/src/old-pages/Clusters/Clusters.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,6 @@ const CLUSTERS_HELP_PANEL_LIST = [
271271
<Trans key="cluster.help.scheduling" i18nKey="cluster.help.scheduling" />,
272272
<Trans key="cluster.help.accounting" i18nKey="cluster.help.accounting" />,
273273
<Trans key="cluster.help.events" i18nKey="cluster.help.events" />,
274-
<Trans key="cluster.help.logs" i18nKey="cluster.help.logs" />,
275274
]
276275

277276
const ClustersHelpPanel = () => {

frontend/src/old-pages/Configure/HeadNode.tsx

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -385,6 +385,16 @@ function IMDSSecuredSettings() {
385385
setState(imdsSecuredPath, !imdsSecured)
386386
}, [imdsSecured])
387387

388+
const footerLinks = React.useMemo(
389+
() => [
390+
{
391+
title: t('wizard.headNode.imdsSecured.imdsv2Link.title'),
392+
href: t('wizard.headNode.imdsSecured.imdsv2Link.href'),
393+
},
394+
],
395+
[t],
396+
)
397+
388398
return (
389399
<CheckboxWithHelpPanel
390400
disabled={editing}
@@ -393,15 +403,8 @@ function IMDSSecuredSettings() {
393403
helpPanel={
394404
<TitleDescriptionHelpPanel
395405
title={t('wizard.headNode.imdsSecured.label')}
396-
description={
397-
<Trans i18nKey="wizard.headNode.imdsSecured.help">
398-
<a
399-
rel="noreferrer"
400-
target="_blank"
401-
href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html#instance-metadata-v2-how-it-works"
402-
></a>
403-
</Trans>
404-
}
406+
description={t('wizard.headNode.imdsSecured.help')}
407+
footerLinks={footerLinks}
405408
/>
406409
}
407410
>
@@ -449,19 +452,7 @@ function HeadNode() {
449452
headerText={t('wizard.headNode.advancedOptions.label')}
450453
>
451454
<SpaceBetween size="xs">
452-
<FormField
453-
label={t('wizard.headNode.securityGroups.label')}
454-
info={
455-
<InfoLink
456-
helpPanel={
457-
<TitleDescriptionHelpPanel
458-
title={t('wizard.headNode.securityGroups.label')}
459-
description={t('wizard.headNode.securityGroups.help')}
460-
/>
461-
}
462-
/>
463-
}
464-
>
455+
<FormField label={t('wizard.headNode.securityGroups.label')}>
465456
<SecurityGroups basePath={headNodePath} />
466457
</FormField>
467458
<SpaceBetween size="xxs">

frontend/src/old-pages/Configure/Queues/SlurmMemorySettings.tsx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,14 @@ const SlurmMemorySettingsHelpPanel = () => {
171171
'wizard.queues.slurmMemorySettings.container.schedulingPropertiesLink.href',
172172
),
173173
},
174+
{
175+
title: t(
176+
'wizard.queues.slurmMemorySettings.container.queueUpdateStrategyLink.title',
177+
),
178+
href: t(
179+
'wizard.queues.slurmMemorySettings.container.queueUpdateStrategyLink.href',
180+
),
181+
},
174182
],
175183
[t],
176184
)

frontend/src/old-pages/Configure/SlurmSettings/SlurmAccountingForm.tsx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,6 @@ const SlurmAccountingsHelpPanel = ({title}: {title: string}) => {
2929
title: t('wizard.headNode.help.databaseLink.title'),
3030
href: t('wizard.headNode.help.databaseLink.href'),
3131
},
32-
{
33-
title: t('wizard.headNode.help.queueLink.title'),
34-
href: t('wizard.headNode.help.queueLink.href'),
35-
},
3632
],
3733
[t],
3834
)

frontend/src/old-pages/Configure/Storage.tsx

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,16 @@ export function FsxLustreSettings({index}: any) {
325325
[t],
326326
)
327327

328+
const lustreCompressionFooterLinks = useMemo(
329+
() => [
330+
{
331+
title: t('wizard.storage.Fsx.compression.link.title'),
332+
href: t('wizard.storage.Fsx.compression.link.href'),
333+
},
334+
],
335+
[t],
336+
)
337+
328338
return (
329339
<SpaceBetween direction="vertical" size="m">
330340
<ColumnLayout columns={2}>
@@ -481,15 +491,8 @@ export function FsxLustreSettings({index}: any) {
481491
helpPanel={
482492
<TitleDescriptionHelpPanel
483493
title={t('wizard.storage.Fsx.compression.label')}
484-
description={
485-
<Trans i18nKey="wizard.storage.Fsx.compression.help">
486-
<a
487-
rel="noreferrer"
488-
target="_blank"
489-
href="https://docs.aws.amazon.com/parallelcluster/latest/ug/SharedStorage-v3.html#yaml-SharedStorage-FsxLustreSettings-DataCompressionType"
490-
></a>
491-
</Trans>
492-
}
494+
description={t('wizard.storage.Fsx.compression.help')}
495+
footerLinks={lustreCompressionFooterLinks}
493496
/>
494497
}
495498
/>

0 commit comments

Comments
 (0)