Docs: Update wording / text and copy (#61868)

Co-authored-by: brendamuir <100768211+brendamuir@users.noreply.github.com>
This commit is contained in:
Gilles De Mey 2023-01-30 16:26:21 +01:00 committed by GitHub
parent 7b47beef2f
commit 702fd0f9e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
26 changed files with 51 additions and 50 deletions

View File

@ -21,7 +21,7 @@ Watch this video to learn more about creating alerts: {{< vimeo 720001934 >}}
## Add Grafana managed rule
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
1. Click **New alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
1. Click **Create alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
1. In Step 1, add the rule name.
- In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
1. In Step 2, add queries and expressions to evaluate, and then select the alert condition.

View File

@ -35,7 +35,7 @@ You can create and manage recording rules for an external Grafana Mimir or Loki
To create a Grafana Mimir or Loki managed recording rule
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
1. Click **New alert rule**. The new alerting rule page opens where the **Grafana managed alert** option is selected by default.
1. Click **Create alert rule**. The new alerting rule page opens where the **Grafana managed alert** option is selected by default.
1. In Step 1, add the rule name. The recording name must be a Prometheus metric name and contain no whitespace.
- In **Rule name**, add a descriptive name.
1. In Step 2, select **Mimir or Loki recording rule** option.
@ -49,7 +49,7 @@ To create a Grafana Mimir or Loki managed recording rule
1. Click **Save** to save the recording rule or **Save and exit** to save the recording rule and go back to the Alerting page.
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
1. Click **New alert rule**.
1. Click **Create alert rule**.
1. In Step 1, add the rule name.
- In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
1. In Step 2, add the type, and storage location.

View File

@ -35,7 +35,7 @@ Watch this video to learn more about how to create a Mimir managed alert rule: {
## Add a Grafana Mimir or Loki managed alerting rule
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
1. Click **New alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
1. Click **Create alert rule**. The new alerting rule page opens where the Grafana managed alerts option is selected by default.
1. In Step 1, add the rule name.
- In **Rule name**, add a descriptive name. This name is displayed in the alert rule list. It is also the `alertname` label for every alert instance that is created from this rule.
1. In Step 2, select **Mimir or Loki alert** option.

View File

@ -24,13 +24,13 @@ Complete the following steps to add a contact point.
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
1. Click **Contact points** to open the page listing existing contact points.
1. Click **New contact point**.
1. Click **Add contact point**.
1. From the **Alertmanager** dropdown, select an Alertmanager. By default, Grafana Alertmanager is selected.
1. In **Name**, enter a descriptive name for the contact point.
1. From **Contact point integration**, select a type and fill out mandatory fields. For example, if you choose email, enter the email addresses. Or if you choose Slack, enter the Slack channel(s) and users who should be contacted.
1. Some contact point integrations, like email or webhook, have optional settings. In **Optional settings**, specify additional settings for the selected contact point integration.
1. In Notification settings, optionally select **Disable resolved message** if you do not want to be notified when an alert resolves.
1. To add another contact point integration, click **New contact point integration** and repeat steps 6 through 8.
1. To add another contact point integration, click **Add contact point integration** and repeat steps 6 through 8.
1. Click **Save contact point** to save your changes.
## Edit a contact point

View File

@ -28,7 +28,7 @@ To add a silence, complete the following steps.
1. In the Grafana menu, click the **Alerting** (bell) icon to open the Alerting page listing existing alerts.
2. On the Alerting page, click **Silences** to open the page listing existing silences.
3. From Alertmanager drop-down, select an external Alertmanager to create and manage silences for the external data source. Otherwise, keep the default option of Grafana.
4. Click **New Silence** to open the Create silence page.
4. Click **Add Silence** to open the Create silence page.
5. In **Silence start and end**, select the start and end date to indicate when the silence should go into effect and expire.
6. Optionally, in **Duration**, specify how long the silence is enforced. This automatically updates the end time in the **Silence start and end** field.
7. In the **Name** and **Value** fields, enter one or more _Matching Labels_. Matchers determine which rules the silence will apply to.

View File

@ -24,7 +24,7 @@ In the Contact points tab, you can see a list of your notification templates.
To create a template, complete the following steps.
1. Click New template.
1. Click **Add template**.
2. Choose a name for the notification template.
@ -40,7 +40,7 @@ To create a template, complete the following steps.
To create a notification template that contains more than one template:
1. Click New Template.
1. Click **Add Template**.
2. Enter a name for the notification template.

View File

@ -517,7 +517,7 @@ func (s *ServiceImpl) buildAlertNavLinks(c *contextmodel.ReqContext, hasEditPerm
if hasAccess(ac.ReqOrgAdminOrEditor, ac.EvalAny(ac.EvalPermission(ac.ActionAlertingNotificationsRead), ac.EvalPermission(ac.ActionAlertingNotificationsExternalRead))) {
alertChildNavs = append(alertChildNavs, &navtree.NavLink{
Text: "Contact points", SubTitle: "Decide how your contacts are notified when an alert fires", Id: "receivers", Url: s.cfg.AppSubURL + "/alerting/notifications",
Text: "Contact points", SubTitle: "Choose how to notify your contact points when an alert instance fires", Id: "receivers", Url: s.cfg.AppSubURL + "/alerting/notifications",
Icon: "comment-alt-share",
})
alertChildNavs = append(alertChildNavs, &navtree.NavLink{Text: "Notification policies", SubTitle: "Determine how alerts are routed to contact points", Id: "am-routes", Url: s.cfg.AppSubURL + "/alerting/routes", Icon: "sitemap"})
@ -545,7 +545,7 @@ func (s *ServiceImpl) buildAlertNavLinks(c *contextmodel.ReqContext, hasEditPerm
}
alertChildNavs = append(alertChildNavs, &navtree.NavLink{
Text: "New alert rule", SubTitle: "Create an alert rule", Id: "alert",
Text: "Create alert rule", SubTitle: "Create an alert rule", Id: "alert",
Icon: "plus", Url: s.cfg.AppSubURL + "/alerting/new", HideFromTabs: true, ShowIconInNavbar: true, IsCreateAction: true,
})
}

View File

@ -162,7 +162,10 @@ export function getNavSubTitle(navId: string | undefined) {
case 'alert-list':
return t('nav.alerting-list.subtitle', 'Rules that determine whether an alert will fire');
case 'receivers':
return t('nav.alerting-receivers.subtitle', 'Decide how your contacts are notified when an alert fires');
return t(
'nav.alerting-receivers.subtitle',
'Choose how to notify your contact points when an alert instance fires'
);
case 'am-routes':
return t('nav.alerting-am-routes.subtitle', 'Determine how alerts are routed to contact points');
case 'silences':

View File

@ -92,8 +92,8 @@ const ui = {
editRouteButton: byLabelText('Edit route'),
deleteRouteButton: byLabelText('Delete route'),
newPolicyButton: byRole('button', { name: /New policy/ }),
newPolicyCTAButton: byRole('button', { name: /New specific policy/ }),
newPolicyButton: byRole('button', { name: /Add policy/ }),
newPolicyCTAButton: byRole('button', { name: /Add specific policy/ }),
savePolicyButton: byRole('button', { name: /save policy/i }),
receiverSelect: byTestId('am-receiver-select'),

View File

@ -95,9 +95,9 @@ const dataSources = {
};
const ui = {
newContactPointButton: byRole('link', { name: /new contact point/i }),
newContactPointButton: byRole('link', { name: /add contact point/i }),
saveContactButton: byRole('button', { name: /save contact point/i }),
newContactPointIntegrationButton: byRole('button', { name: /new contact point integration/i }),
newContactPointIntegrationButton: byRole('button', { name: /add contact point integration/i }),
testContactPointButton: byRole('button', { name: /Test/ }),
testContactPointModal: byRole('heading', { name: /test contact point/i }),
customContactPointOption: byRole('radio', { name: /custom/i }),

View File

@ -121,10 +121,8 @@ const ui = {
rulesFilterInput: byTestId('search-query-input'),
moreErrorsButton: byRole('button', { name: /more errors/ }),
editCloudGroupIcon: byTestId('edit-group'),
newRuleButton: byRole('link', { name: 'New alert rule' }),
newRuleButton: byRole('link', { name: 'Create alert rule' }),
exportButton: byRole('button', { name: /export/i }),
editGroupModal: {
namespaceInput: byRole('textbox', { hidden: true, name: /namespace/i }),
ruleGroupInput: byRole('textbox', { name: 'Evaluation group', exact: true }),
@ -829,7 +827,7 @@ describe('RuleList', () => {
await waitFor(() => expect(mocks.api.fetchRules).toHaveBeenCalledTimes(1));
const button = screen.getByText('New alert rule');
const button = screen.getByText('Create alert rule');
button.addEventListener('click', (event) => event.preventDefault(), false);

View File

@ -121,7 +121,7 @@ const RuleList = withErrorBoundary(
icon="plus"
onClick={() => logInfo(LogMessages.alertRuleFromScratch)}
>
New alert rule
Create alert rule
</LinkButton>
)}
</Stack>

View File

@ -56,7 +56,7 @@ const ui = {
silencesTable: byTestId('dynamic-table'),
silenceRow: byTestId('row'),
silencedAlertCell: byTestId('alerts'),
addSilenceButton: byRole('button', { name: /new silence/i }),
addSilenceButton: byRole('button', { name: /add silence/i }),
queryBar: byPlaceholderText('Search'),
editor: {
timeRange: byLabelText('Timepicker', { exact: false }),

View File

@ -147,7 +147,7 @@ export const AmSpecificRouting: FC<AmSpecificRoutingProps> = ({
<Authorize actions={[permissions.create]}>
<div className={styles.addMatcherBtnRow}>
<Button className={styles.addMatcherBtn} icon="plus" onClick={addNewRoute} type="button">
New policy
Add policy
</Button>
</div>
</Authorize>

View File

@ -114,7 +114,7 @@ const MuteTimingForm = ({ muteTiming, showError, provenance }: Props) => {
pageNav={{
...defaultPageNav,
id: muteTiming ? 'alert-policy-edit' : 'alert-policy-new',
text: muteTiming ? 'Edit mute timing' : 'New mute timing',
text: muteTiming ? 'Edit mute timing' : 'Add mute timing',
}}
>
<AlertManagerPicker

View File

@ -79,7 +79,7 @@ export const MuteTimingsTable: FC<Props> = ({ alertManagerSourceName, muteTiming
variant="primary"
href={makeAMLink('alerting/routes/mute-timing/new', alertManagerSourceName)}
>
New mute timing
Add mute timing
</LinkButton>
</Authorize>
)}

View File

@ -298,9 +298,9 @@ export const ReceiversTable: FC<Props> = ({ config, alertManagerName }) => {
return (
<ReceiversSection
title="Contact points"
description="Define where the notifications will be sent to, for example email or Slack."
description="Define where notifications are sent, for example, email or Slack."
showButton={!isVanillaAM && contextSrv.hasPermission(permissions.create)}
addButtonLabel={'New contact point'}
addButtonLabel={'Add contact point'}
addButtonTo={makeAMLink('/alerting/notifications/receivers/new', alertManagerName)}
>
<DynamicTable

View File

@ -50,8 +50,8 @@ export const TemplatesTable: FC<Props> = ({ config, alertManagerName }) => {
return (
<ReceiversSection
title="Notification templates"
description="Notification templates customize notifications sent from contact points."
addButtonLabel="New template"
description="Create notification templates to customize your notifications."
addButtonLabel="Add template"
addButtonTo={makeAMLink('/alerting/notifications/templates/new', alertManagerName)}
showButton={contextSrv.hasPermission(permissions.create)}
>

View File

@ -159,7 +159,7 @@ export function ReceiverForm<R extends ChannelValues>({
variant="secondary"
onClick={() => append({ ...defaultItem, __id: String(Math.random()) } as R)}
>
New contact point integration
Add contact point integration
</Button>
)}
<div className={styles.buttons}>

View File

@ -16,7 +16,7 @@ export const NoRulesSplash = () => {
title="You haven`t created any alert rules yet"
buttonIcon="bell"
buttonLink={'alerting/new'}
buttonTitle="New alert rule"
buttonTitle="Create alert rule"
proTip="you can also create alert rules from existing panels and queries."
proTipLink="https://grafana.com/docs/"
proTipLinkTitle="Learn more"

View File

@ -20,7 +20,7 @@ export const NoSilencesSplash: FC<Props> = ({ alertManagerSourceName }) => {
title="You haven't created any silences yet"
buttonIcon="bell-slash"
buttonLink={makeAMLink('alerting/silence/new', alertManagerSourceName)}
buttonTitle="New silence"
buttonTitle="Create silence"
/>
);
}

View File

@ -71,7 +71,7 @@ const SilencesTable: FC<Props> = ({ silences, alertManagerAlerts, alertManagerSo
<div className={styles.topButtonContainer}>
<Link href={makeAMLink('/alerting/silence/new', alertManagerSourceName)}>
<Button className={styles.addNewSilence} icon="plus">
New Silence
Add Silence
</Button>
</Link>
</div>

View File

@ -132,7 +132,7 @@ export const navIndex: NavIndex = {
{
id: 'receivers',
text: 'Contact points',
subTitle: 'Decide how your contacts are notified when an alert fires',
subTitle: 'Choose how to notify your contact points when an alert instance fires',
icon: 'comment-alt-share',
url: '/alerting/notifications',
},
@ -171,7 +171,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -198,7 +198,7 @@ export const navIndex: NavIndex = {
receivers: {
id: 'receivers',
text: 'Contact points',
subTitle: 'Decide how your contacts are notified when an alert fires',
subTitle: 'Choose how to notify your contact points when an alert instance fires',
icon: 'comment-alt-share',
url: '/alerting/notifications',
},
@ -231,7 +231,7 @@ export const navIndex: NavIndex = {
},
alert: {
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',

View File

@ -418,7 +418,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -722,7 +722,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -789,7 +789,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -857,7 +857,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -925,7 +925,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -993,7 +993,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -1061,7 +1061,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -1129,7 +1129,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -1141,7 +1141,7 @@ export const navIndex: NavIndex = {
},
alert: {
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',
@ -1200,7 +1200,7 @@ export const navIndex: NavIndex = {
},
{
id: 'alert',
text: 'New alert rule',
text: 'Create alert rule',
subTitle: 'Create an alert rule',
icon: 'plus',
url: '/alerting/new',

View File

@ -160,7 +160,7 @@
"title": "Alert rules"
},
"alerting-receivers": {
"subtitle": "Decide how your contacts are notified when an alert fires",
"subtitle": "Choose how to notify your contact points when an alert instance fires",
"title": "Contact points"
},
"alerting-silences": {
@ -191,7 +191,7 @@
"title": "Create"
},
"create-alert": {
"title": "New alert rule"
"title": "Create alert rule"
},
"create-dashboard": {
"title": "Dashboard"

View File

@ -577,4 +577,4 @@
"option-tooltip": "Cľęäř şęľęčŧįőʼnş"
}
}
}
}