Skip to content

Commit

Permalink
fix(quickstarts): remove outdated feature descriptions (#1273)
Browse files Browse the repository at this point in the history
* fix(quickstart): rename WebSocket Connection Debouce -> WebSocket retry interval

* remove explicit versioning, quickstarts correspond to whichever release they are developed with and embedded into

* remove mention of "View Report" action from recording quickstart

* remove mention of credentials storage location

* add note about client-side feature flags
  • Loading branch information
andrewazores authored Jun 7, 2024
1 parent 04ec3f6 commit 1074c00
Show file tree
Hide file tree
Showing 9 changed files with 9 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ const AutomatedRulesQuickStart: QuickStart = {
order: 3,
},
spec: {
version: 2.3,
displayName: displayName,
durationMinutes: 5,
icon: <CryostatIcon />,
Expand Down
3 changes: 1 addition & 2 deletions src/app/QuickStarts/quickstarts/dashboard-quickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ const DashboardQuickStart: QuickStart = {
order: 2,
},
spec: {
version: 2.3,
displayName: displayName,
durationMinutes: 10,
icon: <CryostatIcon />,
Expand Down Expand Up @@ -163,7 +162,7 @@ You can rename, delete and quickly switch between **Dashboard Layouts** for diff
conclusion: conclusion(
displayName,
'Dashboard',
`For more information about the new <strong>Dashboard</strong> and <strong>Dashboard Cards</strong> in [APP] ${build.version}, read our guides on the <a href="${build.dashboardGuideUrl}" target="_blank">Cryostat documentation</a>.`,
`For more information about the <strong>Dashboard</strong> and <strong>Dashboard Cards</strong> in [APP] ${build.version}, read our guides on the <a href="${build.dashboardGuideUrl}" target="_blank">Cryostat documentation</a>.`,
),
type: {
text: 'Introduction',
Expand Down
1 change: 0 additions & 1 deletion src/app/QuickStarts/quickstarts/generic-quickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ const GenericQuickStart: QuickStart = {
// you can add additional metadata here
},
spec: {
version: 2.3, // versioning for each release of the quick start
displayName: displayName,
durationMinutes: 10,
type: {
Expand Down
10 changes: 3 additions & 7 deletions src/app/QuickStarts/quickstarts/settings-quickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ const SettingsQuickStart: QuickStart = {
order: 100,
},
spec: {
version: 2.3,
displayName: displayName,
durationMinutes: 5,
icon: <CogIcon />,
Expand Down Expand Up @@ -64,7 +63,7 @@ The **General** settings tab is where you can adjust various general settings to
The **Connectivity** tab enables you to configure the WebSocket connection between the browser and the [APP] backend.
1. Click [Connectivity]{{highlight settings-connectivity-tab}}.
2. Configure the **WebSocket Connection Debounce** time.
2. Configure the **WebSocket retry interval** time.
3. Configure the **Auto-refresh** period for content-views.
[To use the **Auto-refresh** feature, make sure to enable the [Auto-refresh]{{highlight settings-connectivity-tab-auto-refresh}} checkbox.]{{admonition tip}}
`,
Expand Down Expand Up @@ -101,12 +100,9 @@ The **automated analysis** Dashboard Card allows you to automatically start an a
[APP] has a few advanced settings that can be configured.
1. Click [Advanced]{{highlight settings-advanced-tab}}.
2. Configure the **Credentials Storage** settings.
2. Configure the **feature level** settings.
Credentials are necessary to authenticate with the target JVMs that [APP] communicates with, if JMX auth is enabled or if a [APP] agent authenticated connection is required. If you prefer not to store these credentials in the [APP] backend, you can opt to store them in local session storage instead.
3. Configure the **feature level** settings.
The **feature level** setting enables you to enable or disable beta features.
The **feature level** setting enables you to enable or disable beta features. This is a client-side switch that only applies to the particular web browser and Cryostat instance where it is set.
`,
},
Expand Down
8 changes: 3 additions & 5 deletions src/app/QuickStarts/quickstarts/start-a-recording.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ const RecordingQuickStart: QuickStart = {
order: 1,
},
spec: {
version: 2.3,
displayName: displayName,
durationMinutes: 10,
icon: <CryostatIcon />,
Expand Down Expand Up @@ -129,14 +128,13 @@ Downloading a Recording will save the Recording to your local machine as a JFR f
title: 'View an analysis report',
description: `
[APP] is able to generate an **Automated analysis report** using a JFR Recording. The **Java Mission Control** rules engine analyzes your Recording, looks for common problems, and assigns a severity score from 0 (no problem) to 100 (potentially severe problem) to each problem.
1. Click the [kebab menu]{{highlight recording-kebab}} next to the Recording that you want to view an analysis report for.
2. Click \`View Report ...\` to view an analysis report of the Recording in a new tab.
3. *Optional:* Right click on the page and select \`Save Page As...\` to download the report HTML file to your local machine.
1. Click the [row chevron]{{highlight recording-chevron}} next to the Recording that you want to view an analysis report for.
2. If no tile groups appear then no problems were detected in your Recording. If any tiles do appear you can click on each one to view its severity score and see any suggestions to fix the problem.
`,
review: {
instructions: '#### Verify that you can see an analysis report of the Recording.',
failedTaskHelp:
'The kebab `⁝` should be next to the Recording row in the Active Recordings table. Clicking the kebab icon should show a menu with the `View Report ...` option.',
'The chevron `>` should be at the beginning of the Recording row in the **Active Recordings** or **Archived Recordings** tables. Clicking the chevron should expand the table row and reveal the analysis report tiles',
},
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ const CustomTargetQuickstart: QuickStart = {
featureLevel: FeatureLevel.PRODUCTION,
},
spec: {
version: 2.3,
displayName: 'Create a Custom Target',
durationMinutes: 10,
icon: <CryostatIcon />,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,11 @@ import { FeatureLevel } from '@app/Shared/Services/service.types';
import { QuickStart } from '@patternfly/quickstarts';

const GroupStartRecordingQuickStart: QuickStart = {
apiVersion: 'v2.3.0',
metadata: {
name: 'topology/start-group-recording',
featureLevel: FeatureLevel.PRODUCTION,
},
spec: {
version: 2.3,
displayName: 'Start Recording on multiple target JVMs',
durationMinutes: 5,
icon: <CryostatIcon />,
Expand Down
1 change: 1 addition & 0 deletions src/app/Recordings/ActiveRecordingsTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -931,6 +931,7 @@ export const ActiveRecordingRow: React.FC<ActiveRecordingRowProps> = ({
isExpanded: isExpanded,
onToggle: handleToggle,
}}
data-quickstart-id="recording-chevron"
/>
<Td key={`active-table-row-${index}_2`} dataLabel={tableColumns[0].title}>
{recording.name}
Expand Down
1 change: 1 addition & 0 deletions src/app/Recordings/ArchivedRecordingsTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -874,6 +874,7 @@ export const ArchivedRecordingRow: React.FC<ArchivedRecordingRowProps> = ({
isExpanded: isExpanded,
onToggle: handleToggle,
}}
data-quickstart-id="recording-chevron"
/>
<Td key={`archived-table-row-${index}_2`} dataLabel={tableColumns[0].title}>
{recording.name}
Expand Down

0 comments on commit 1074c00

Please sign in to comment.