Skip to content

Commit 8f0b61f

Browse files
docs(quickstart): clean up various items (#1925) (#1926)
(cherry picked from commit 8d4bf6c) Co-authored-by: Andrew Azores <[email protected]>
1 parent e6886b3 commit 8f0b61f

File tree

10 files changed

+25
-15
lines changed

10 files changed

+25
-15
lines changed

src/app/Diagnostics/HeapDumpsTable.tsx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,14 @@ export const HeapDumpRow: React.FC<HeapDumpRowProps> = ({
607607
<Td key={`heap-dump-table-row-${index}_4`} dataLabel={tableColumns[3].title}>
608608
{formatBytes(heapDump.size ?? 0)}
609609
</Td>
610-
{<HeapDumpAction heapDump={heapDump} index={index} onDownload={onDownload} />}
610+
{
611+
<HeapDumpAction
612+
heapDump={heapDump}
613+
index={index}
614+
onDownload={onDownload}
615+
data-quickstart-id="heap-dumps-kebab"
616+
/>
617+
}
611618
</Tr>
612619
);
613620
}, [

src/app/Diagnostics/ThreadDumpsTable.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,7 @@ export const ThreadDumpRow: React.FC<ThreadDumpRowProps> = ({
609609
<Td key={`thread-dump-table-row-${index}_4`} dataLabel={tableColumns[3].title}>
610610
{formatBytes(threadDump.size ?? 0)}
611611
</Td>
612-
{<ThreadDumpAction threadDump={threadDump} onDownload={onDownload} />}
612+
{<ThreadDumpAction threadDump={threadDump} onDownload={onDownload} data-quickstart-id="thread-dumps-kebab" />}
613613
</Tr>
614614
);
615615
}, [

src/app/QuickStarts/quickstarts/automated-rules-quickstart.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Automated Rules are configurations that instruct [APP] to create JDK Flight Reco
6565
description: `
6666
To create a new rule, use the Automated Rule creation form to fill in the required fields.
6767
68-
The [Match Expression]{{highlight rule-matchexpr}} field is a <a target="_blank" href="${CEL_SPEC_HREF}">Common Expression Language (CEL)</a> code snippet that is matched against each Target JVM. This allows you to create rules that run on specific target JVMs. For example, you can create a rule that runs on all target JVMs with the Match Expression: \`true\`{{copy}}. You can also match targets more specifically with a Match Expression like \`target.annotations.cryostat['PORT'] == 9091\`{{copy}}, which will match targets that are connected to [APP] on port 9091.
68+
The [Match Expression]{{highlight rule-matchexpr}} field is a <a target="_blank" href="${CEL_SPEC_HREF}">Common Expression Language (CEL)</a> code snippet that is matched against each Target JVM. This allows you to create rules that run on specific target JVMs. For example, you can create a rule that runs on all target JVMs with the Match Expression: \`true\`{{copy}}. You can also match targets more specifically with a Match Expression like \`has(target.annotations.cryostat.PORT) && target.annotations.cryostat.PORT == 9091\`{{copy}}, which will match targets that are connected to [APP] on port 9091.
6969
7070
7171
To create a new rule, you must fill out the following required fields:

src/app/QuickStarts/quickstarts/settings-quickstart.tsx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,19 @@ The **Notifications & messages** tab allows you to configure the notifications a
8484
description: `
8585
The **Dashboard** tab allows you to configure settings for the various Dashboard Cards that you can add to the Dashboard.
8686
87-
The **automated analysis** Dashboard Card allows you to automatically start an analysis on the Recording with a click of a button. You can configure the Recording that is started by this card.
88-
8987
1. From the list of settings tabs, click [Dashboard]{{highlight settings-dashboard-tab}}.
90-
2. Configure the **Automated analysis Recording configuration** settings.
91-
3. Configure the **Dashboard metrics configuration** settings.
88+
2. Configure the **Dashboard metrics configuration** settings.
9289
93-
[When using the **automated analysis card**, make sure the **Event Template** is compatible with the Target JVM.]{{admonition warning}}
94-
[Setting both an infinite maximum size and age may result in an **Out Of Memory** error during report generation.]{{admonition caution}}
9590
`,
9691
},
92+
{
93+
title: 'Go to the **Topology** tab',
94+
description: `
95+
The **Topology** tab allows you to configure settings for the Topology view.
96+
1. Click [Topology]{{highlight settings-topology-tab}}
97+
2. Move Automated Analysis Rule types between the Analyzed and Ignored lists to configure how scores and statuses are determined within the Topology view.
98+
`,
99+
},
97100
{
98101
title: 'Go to the **Advanced** tab',
99102
description: `

src/app/RecordingMetadata/RecordingLabelFields.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ export const RecordingLabelFields: React.FC<RecordingLabelFieldsProps> = ({
189189
</>
190190
)}
191191
<LabelGroup
192-
categoryName="Recording Labels"
192+
categoryName="Labels"
193193
numLabels={10}
194194
isEditable
195195
addLabelControl={

src/test/CreateRecording/__snapshots__/CustomRecordingForm.test.tsx.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -586,7 +586,7 @@ exports[`<CustomRecordingForm /> renders correctly 1`] = `
586586
className="pf-v5-c-label-group__label"
587587
id="pf-random-id-4"
588588
>
589-
Recording Labels
589+
Labels
590590
</span>
591591
<ul
592592
aria-labelledby="pf-random-id-4"

src/test/Diagnostics/__snapshots__/BulkEditHeapDumpLabels.test.tsx.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ exports[`<BulkEditHeapDumpLabels /> renders correctly 1`] = `
6161
className="pf-v5-c-label-group__label"
6262
id="pf-random-id-0"
6363
>
64-
Recording Labels
64+
Labels
6565
</span>
6666
<ul
6767
aria-labelledby="pf-random-id-0"

src/test/Diagnostics/__snapshots__/BulkEditThreadDumpLabels.test.tsx.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ exports[`<BulkEditThreadDumpLabels /> renders correctly 1`] = `
6161
className="pf-v5-c-label-group__label"
6262
id="pf-random-id-0"
6363
>
64-
Recording Labels
64+
Labels
6565
</span>
6666
<ul
6767
aria-labelledby="pf-random-id-0"

src/test/RecordingMetadata/__snapshots__/BulkEditLabels.test.tsx.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ exports[`<BulkEditLabels /> renders correctly 1`] = `
6161
className="pf-v5-c-label-group__label"
6262
id="pf-random-id-0"
6363
>
64-
Recording Labels
64+
Labels
6565
</span>
6666
<ul
6767
aria-labelledby="pf-random-id-0"

src/test/RecordingMetadata/__snapshots__/RecordingLabelFields.test.tsx.snap

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ exports[`<RecordingLabelFields /> renders correctly 1`] = `
1212
className="pf-v5-c-label-group__label"
1313
id="pf-random-id-0"
1414
>
15-
Recording Labels
15+
Labels
1616
</span>
1717
<ul
1818
aria-labelledby="pf-random-id-0"

0 commit comments

Comments
 (0)