Skip to content

Commit

Permalink
fix inconsistent capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
aali309 committed May 22, 2024
1 parent 8aa5968 commit d6edfb8
Show file tree
Hide file tree
Showing 50 changed files with 322 additions and 322 deletions.
2 changes: 1 addition & 1 deletion src/app/About/AboutDescription.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export const AboutDescription: React.FC = () => {
const result = cryostatVersion.match(expr);
if (!result) {
notificationsContext.warning(
'Cryostat Version Parse Failure',
'Cryostat version parse failure',
`Could not parse Cryostat version string '${cryostatVersion}'.`,
);
return;
Expand Down
4 changes: 2 additions & 2 deletions src/app/AppLayout/NotificationCenter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ export const NotificationCenter: React.FC<NotificationCenterProps> = ({ onClose
const [totalUnreadNotificationsCount, setTotalUnreadNotificationsCount] = React.useState(0);
const [isHeaderDropdownOpen, setHeaderDropdownOpen] = React.useState(false);
const [drawerCategories, setDrawerCategories] = React.useState([
{ title: 'Completed Actions', isExpanded: true, notifications: [] as Notification[], unreadCount: 0 },
{ title: 'Cryostat Status', isExpanded: false, notifications: [] as Notification[], unreadCount: 0 },
{ title: 'Completed actions', isExpanded: true, notifications: [] as Notification[], unreadCount: 0 },
{ title: 'Cryostat status', isExpanded: false, notifications: [] as Notification[], unreadCount: 0 },
{ title: 'Problems', isExpanded: true, notifications: [] as Notification[], unreadCount: 0 },
] as NotificationDrawerCategory[]);

Expand Down
6 changes: 3 additions & 3 deletions src/app/CreateRecording/CreateRecording.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ export const CreateRecording: React.FC = () => {
);

return (
<TargetView pageTitle="Create Recording" breadcrumbs={[{ title: 'Recordings', path: '/recordings' }]}>
<TargetView pageTitle="Create recording" breadcrumbs={[{ title: 'Recordings', path: '/recordings' }]}>
<Card>
<CardBody>
<Tabs activeKey={activeTab} onSelect={onTabSelect}>
<Tab eventKey={0} title="Custom Flight Recording">
<Tab eventKey={0} title="Custom Flight recording">
<CustomRecordingForm />
</Tab>
<Tab eventKey={1} title="Snapshot Recording">
<Tab eventKey={1} title="Snapshot recording">
<SnapshotRecordingForm />
</Tab>
</Tabs>
Expand Down
2 changes: 1 addition & 1 deletion src/app/CreateRecording/CustomRecordingForm.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ export const CustomRecordingForm: React.FC = () => {
setAdvancedRecordingOptions(recordingOptions);
},
error: (error) => {
setErrorMessage(isTargetAgentHttp(target) ? 'Unsupported operation: Create recordings' : error.message);
setErrorMessage(isTargetAgentHttp(target) ? 'Unsupported operation: Create Recordings' : error.message);
setTemplates([]);
setFormData((old) => ({ ...old, template: undefined }));
setAdvancedRecordingOptions({});
Expand Down
2 changes: 1 addition & 1 deletion src/app/Dashboard/DashboardCardActionMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ export const DashboardCardActionMenu: React.FC<DashboardCardActionProps> = ({
<DropdownItem key="Remove" onClick={onRemove}>
{t('REMOVE', { ns: 'common' })}
</DropdownItem>,
<DropdownItem key="Reset Size" onClick={onResetSize}>
<DropdownItem key="Reset size" onClick={onResetSize}>
{t('DashboardCardActionMenu.RESET_SIZE')}
</DropdownItem>,
]}
Expand Down
4 changes: 2 additions & 2 deletions src/app/Dashboard/LayoutTemplateUploadModal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ export const LayoutTemplateUploadModal: React.FC<LayoutTemplateUploadModalProps>
onSingleSuccess(
fileUpload.file.name,
<Text component="p" style={{ color: 'var(--pf-global--warning-color--200)' }}>
Warning: To see this template in the template picker, make sure the Cryostat Feature Level is set
Warning: To see this template in the template picker, make sure the Cryostat Feature level is set
to BETA.
</Text>,
);
Expand Down Expand Up @@ -250,7 +250,7 @@ export const LayoutTemplateUploadModal: React.FC<LayoutTemplateUploadModalProps>
}
>
<Form>
<FormGroup label="JSON File" isRequired fieldId="file">
<FormGroup label="JSON file" isRequired fieldId="file">
<MultiFileUpload
submitRef={submitRef}
abortRef={abortRef}
Expand Down
2 changes: 1 addition & 1 deletion src/app/Dashboard/cryostat-dashboard-templates.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ const JFRMonitoringLayout: LayoutTemplate = {
span: 3,
props: {
theme: 'light',
chartKind: 'Recording Start Time',
chartKind: 'Recording Start time',
duration: 120,
period: 10,
},
Expand Down
2 changes: 1 addition & 1 deletion src/app/Events/EventTemplates.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -254,7 +254,7 @@ export const EventTemplates: React.FC<EventTemplatesProps> = (_) => {
(t: EventTemplate) => {
let actions = [
{
title: 'Create Recording...',
title: 'Create recording...',
onClick: () =>
navigate('/recordings/create', {
state: { template: { name: t.name, type: t.type } } as Partial<CustomRecordingFormData>,
Expand Down
4 changes: 2 additions & 2 deletions src/app/Joyride/CryostatJoyride.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,10 @@ const CryostatJoyride: React.FC<CryostatJoyrideProps> = ({ children }) => {
placement: 'right',
},
{
title: 'Automated Rules',
title: 'Automated rules',
content: (
<p>
Create, delete, enable, and view Cryostat <strong>Automated Rules</strong> in this view. Automated Rules
Create, delete, enable, and view Cryostat <strong>Automated rules</strong> in this view. Automated rules
allow you start recordings on target JVMs based on a set of conditions.
</p>
),
Expand Down
66 changes: 33 additions & 33 deletions src/app/Modal/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,97 +39,97 @@ export interface DeleteOrDisableWarning {
export const DeleteActiveRecordings: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteActiveRecordings,
title: 'Permanently delete your JFR recording?',
label: 'Delete Active Recording',
description: `If you click delete, recording and report data will be lost.`,
label: 'Delete Active recording',
description: `If you click Delete, recording and report data will be lost.`,
ariaLabel: 'Recording delete warning',
};

export const DeleteArchivedRecordings: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteArchivedRecordings,
title: 'Permanently delete your archived JFR recording?',
label: 'Delete Archived Recording',
description: `If you click delete, recording and report data will be lost.`,
title: 'Permanently delete your Archived JFR recording?',
label: 'Delete Archived recording',
description: `If you click Delete, recording and report data will be lost.`,
ariaLabel: 'Recording delete warning',
};

export const DeleteAutomatedRules: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteAutomatedRules,
title: 'Permanently delete your Automated Rule?',
label: 'Delete Automated Rule',
description: `If you click delete, rule data will be lost.`,
title: 'Permanently delete your Automated rule?',
label: 'Delete Automated rule',
description: `If you click Delete, rule data will be lost.`,
ariaLabel: 'Automated rule delete warning',
};

export const DisableAutomatedRules: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DisableAutomatedRules,
title: 'Disable your Automated Rule?',
label: 'Disable Automated Rule',
title: 'Disable your Automated rule?',
label: 'Disable Automated rule',
description: `If you click Disable, the rule will be disabled.`,
ariaLabel: 'Automated rule disable warning',
};

export const DeleteEventTemplates: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteEventTemplates,
title: 'Permanently delete your Event Template?',
label: 'Delete Event Template',
description: `If you click delete, custom event template data will be lost.`,
title: 'Permanently delete your Event template?',
label: 'Delete Event template',
description: `If you click Delete, custom event template data will be lost.`,
ariaLabel: 'Event template delete warning',
};

export const DeleteProbeTemplates: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteProbeTemplates,
title: 'Permanently delete your Probe Template?',
label: 'Delete Probe Template',
description: `If you click delete, custom probe template data will be lost.`,
title: 'Permanently delete your Probe template?',
label: 'Delete Probe template',
description: `If you click Delete, custom Probe template data will be lost.`,
ariaLabel: 'Probe template delete warning',
};

export const DeleteActiveProbes: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteActiveProbes,
title: 'Permanently remove your Active Probes from the target?',
label: 'Remove Active Probes',
description: `If you click delete, active probes will be removed from the target.`,
title: 'Permanently remove your active Probes from the target?',
label: 'Remove active Probes',
description: `If you click Delete, active Probes will be removed from the target.`,
ariaLabel: 'Active Probes remove warning',
};

export const DeleteCredentials: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteCredentials,
title: 'Permanently delete your Credentials?',
label: 'Delete Credentials',
description: `If you click delete, credential data for this target will be lost.`,
description: `If you click Delete, Credential data for this target will be lost.`,
ariaLabel: 'Credentials delete warning',
};

export const DeleteCustomTargets: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteCustomTargets,
title: 'Permanently delete your Custom Target?',
label: 'Delete Custom Targets',
description: `If you click delete, custom target information will be lost.`,
description: `If you click Delete, Custom Target information will be lost.`,
ariaLabel: 'Custom Targets delete warning',
};

export const DeleteDashboardLayout: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteDashboardLayout,
title: 'Permanently delete your Dashboard Layout?',
label: 'Delete Dashboard Layouts',
description: `If you click delete, dashboard layout configuration data will be lost.`,
ariaLabel: 'Dashboard Layout delete warning',
title: 'Permanently delete your Dashboard layout?',
label: 'Delete Dashboard layouts',
description: `If you click Delete, Dashboard layout configuration data will be lost.`,
ariaLabel: 'Dashboard layout delete warning',
};

export const ClearDashboardLayout: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.ClearDashboardLayout,
title: 'Permanently clear your Dashboard Layout?',
label: 'Clear Dashboard Layout',
description: 'If you click clear, all cards in the current dashboard layout will be removed.',
ariaLabel: 'Dashboard Layout clear warning',
title: 'Permanently clear your Dashboard layout?',
label: 'Clear Dashboard layout',
description: 'If you click Clear, all cards in the current Dashboard layout will be removed.',
ariaLabel: 'Dashboard layout clear warning',
};

export const DeleteLayoutTemplate: DeleteOrDisableWarning = {
id: DeleteOrDisableWarningType.DeleteLayoutTemplate,
title: 'Permanently delete your Layout Template?',
label: 'Delete Layout Template',
description: `If you click delete, layout template configuration data will be lost.`,
ariaLabel: 'Layout Template delete warning',
title: 'Permanently delete your Layout template?',
label: 'Delete Layout template',
description: `If you click Delete, Layout template configuration data will be lost.`,
ariaLabel: 'Layout template delete warning',
};

export const DeleteWarningKinds: DeleteOrDisableWarning[] = [
Expand Down
2 changes: 1 addition & 1 deletion src/app/QuickStarts/QuickStartsCatalogPage.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const QuickStartsCatalogPage: React.FC<QuickStartsCatalogPageProps> = (_) => {
const { t } = useTranslation();

// TODO: Quick start categories (patternfly/quickstarts supports this through individual components)
// e.g. Dashboard Quick Starts, Topology Quick Starts, Recording Quick Starts, etc.
// e.g. Dashboard Quick starts, Topology Quick starts, Recording Quick starts, etc.
return (
<QuickStartCatalogPage
title={t('QuickStarts.CATALOG_PAGE.TITLE')}
Expand Down
4 changes: 2 additions & 2 deletions src/app/QuickStarts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ TODO: Fix this section when quick starts are categorized
[About]{{highlight nav-about-tab}}
[Dashboard]{{highlight nav-dashboard-tab}}
[Topology]{{highlight nav-topology-tab}}
[Automated Rules]{{highlight nav-automatedrules-tab}}
[Automated rules]{{highlight nav-automatedrules-tab}}
[Recordings]{{highlight nav-recordings-tab}}
[Archives]{{highlight nav-archives-tab}}
[Events]{{highlight nav-events-tab}}
Expand All @@ -39,7 +39,7 @@ TODO: Fix this section when quick starts are categorized
[Application Launcher]{{highlight application-launcher}}
```
### Some other notes:
* When showing user-facing strings, refer to quick starts as `quick starts` and not `Quick Starts`, `QuickStarts`, or `quickstarts`.
* When showing user-facing strings, refer to quick starts as `quick starts` and not `Quick starts`, `QuickStarts`, or `quickstarts`.
* While rendering markdown, when mentioning the Product name itself, use `[APP]` instead of `Cryostat`.
* The conclusion should stay largely consistent in all quick starts. Refer to the `generic-quickstart.tsx` for an example.

Expand Down
30 changes: 15 additions & 15 deletions src/app/QuickStarts/quickstarts/automated-rules-quickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import { FeatureLevel } from '@app/Shared/Services/service.types';
import { QuickStart } from '@patternfly/quickstarts';
import { CryostatIcon, conclusion } from '../quickstart-utils';

const displayName = 'Get started with Automated Rules';
const displayName = 'Get started with Automated rules';

const AutomatedRulesQuickStart: QuickStart = {
metadata: {
Expand All @@ -31,10 +31,10 @@ const AutomatedRulesQuickStart: QuickStart = {
durationMinutes: 5,
icon: <CryostatIcon />,
description: `Learn about automated rules in **[APP]** and how to create one.`,
prerequisites: ['Start a Recording'],
prerequisites: ['Start a recording'],
introduction: `
## Automated Rules
Automated Rules are configurations that instruct [APP] to create JDK Flight Recordings on matching target JVM applications. Each rule specifies parameters for which Event Template to use, how much data should be kept in the application recording buffer, and how frequently [APP] should copy the application recording buffer into [APP]'s own archived storage.
## Automated rules
Automated rules are configurations that instruct [APP] to create JDK Flight Recordings on matching target JVM applications. Each rule specifies parameters for which Event Template to use, how much data should be kept in the application recording buffer, and how frequently [APP] should copy the application recording buffer into [APP]'s own archived storage.
### What you'll learn
Expand All @@ -49,29 +49,29 @@ Automated Rules are configurations that instruct [APP] to create JDK Flight Reco
`,
tasks: [
{
title: 'Create a new Automated Rule',
title: 'Create a new Automated rule',
description: `
1. In the [APP] console navigation bar, click [Automated Rules]{{highlight nav-automatedrules-tab}}.
1. In the [APP] console navigation bar, click [Automated rules]{{highlight nav-automatedrules-tab}}.
2. Click [Create]{{highlight create-rule-btn}}.
`,
review: {
instructions: '#### Verify that you see the Automated Rules creation form.',
instructions: '#### Verify that you see the Automated rules creation form.',
failedTaskHelp:
'If you do not see the navigation bar, click the [menu button]{{highlight nav-toggle-btn}} on the masthead.',
},
},
{
title: 'Fill out the Automated Rule form',
title: 'Fill out the Automated rule form',
description: `
To create a new rule, use the Automated Rule creation form to fill in the required fields.
To create a new rule, use the Automated rule creation form to fill in the required fields.
The [Match Expression]{{highlight rule-matchexpr}} field is a Java-like 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.
The [Match expression]{{highlight rule-matchexpr}} field is a Java-like 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.
To create a new rule, you must fill out the following required fields:
1. Enter a name for the rule in the [Name]{{highlight rule-name}} field.
2. Enter an expression in the [Match Expression]{{highlight rule-matchexpr}} field. To see an example match expression, click the [match hint]{{highlight rule-matchexpr-help}}.
[Use the [Match Expression Visualizer]{{highlight match-expr-card}} to test your match expression against the target JVMs currently discovered by [APP]. Any matched targets will appear unfaded in the Graph view and will be listed in the List view.]{{admonition tip}}
2. Enter an expression in the [Match expression]{{highlight rule-matchexpr}} field. To see an example match expression, click the [match hint]{{highlight rule-matchexpr-help}}.
[Use the [Match expression visualizer]{{highlight match-expr-card}} to test your match expression against the target JVMs currently discovered by [APP]. Any matched targets will appear unfaded in the Graph view and will be listed in the List view.]{{admonition tip}}
3. Select an [Event Template]{{highlight rule-evt-template}}.
Expand All @@ -81,7 +81,7 @@ To create a new rule, you must fill out the following required fields:
`,
review: {
instructions: '#### Verify that you see the new rule in the Automated Rules table.',
instructions: '#### Verify that you see the new rule in the Automated rules table.',
failedTaskHelp: `If you do not see the new rule, follow the previous steps again.
If you cannot create the rule, check that you have entered valid values for each required field.`,
},
Expand All @@ -101,13 +101,13 @@ The recording should be named according to the rule-name format, such as \`auto_
`,
review: {
instructions:
'#### Verify that you see the new recording with the correct Automated Rule recording naming scheme in the list of recordings.',
'#### Verify that you see the new recording with the correct Automated rule recording naming scheme in the list of recordings.',
failedTaskHelp:
'If you do not see the new recording, go back to the Rule Creation form, and try verifying that your rule match expression correctly matches the intended target JVMs in this task.',
},
},
],
conclusion: conclusion(displayName, 'Automated Rules'),
conclusion: conclusion(displayName, 'Automated rules'),
type: {
text: 'Advanced',
color: 'red',
Expand Down
2 changes: 1 addition & 1 deletion src/app/QuickStarts/quickstarts/generic-quickstart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import { PficonTemplateIcon } from '@patternfly/react-icons';
import { conclusion } from '../quickstart-utils';

// Quick start name (currently cannot use [APP], there is a bug with how the title gets rendered in the quick start panel)
const displayName = 'Getting started with quick starts in Cryostat';
const displayName = 'Getting started with Quick starts in Cryostat';

// Additional info: https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html
const GenericQuickStart: QuickStart = {
Expand Down
Loading

0 comments on commit d6edfb8

Please sign in to comment.