diff --git a/workspaces/ilert/.changeset/lemon-scissors-greet.md b/workspaces/ilert/.changeset/lemon-scissors-greet.md new file mode 100644 index 00000000000..74467e43710 --- /dev/null +++ b/workspaces/ilert/.changeset/lemon-scissors-greet.md @@ -0,0 +1,5 @@ +--- +'@backstage-community/plugin-ilert': patch +--- + +Align plugin copy and docs to ilert naming; update README, config types, and UI wording (alerts). diff --git a/workspaces/ilert/plugins/ilert/README.md b/workspaces/ilert/plugins/ilert/README.md index e9a5d8ca8f9..0f60b1ee22f 100644 --- a/workspaces/ilert/plugins/ilert/README.md +++ b/workspaces/ilert/plugins/ilert/README.md @@ -2,24 +2,34 @@ ## Introduction -[iLert](https://www.ilert.com) is a platform for alerting, on-call management and uptime monitoring. It helps teams to reduce response times to critical incidents by extending monitoring tools with reliable alerting, automatic escalations, on-call schedules and other features to support the incident response process, such as informing stakeholders or creating tickets in external incident management tools. +[ilert](https://www.ilert.com) The AI-first platform for on-call, incident response, and status pages – eliminating the interrupt tax across your stack. ## Overview -This plugin gives an overview about ongoing iLert incidents, on-call and uptime monitor status. -See who is on-call, which incidents are active and trigger incidents directly from backstage for the configured alert sources. +This plugin integrates ilert into Backstage and provides an overview of operational information such as alerts, on-call schedules, services, and status pages. -In detail this plugin provides: +It allows users to: -- Information details about the person on-call (all escalation levels of the current time) -- A way to override the current on-call person -- A list of active incidents -- A way to trigger a new incident -- A way to reassign/acknowledge/resolve an incident -- A way to trigger an incident action -- A way to trigger an immediate maintenance -- A way to disable/enable an alert source -- A list of uptime monitors +- See who is currently on-call +- View active alerts +- Trigger alerts directly from Backstage for configured alert sources +- View services and their current status +- Access status pages + +### Features + +This plugin provides the following functionality: + +- View details about the current on-call person (including all escalation levels) +- Override the current on-call assignment +- View a list of active alerts +- Trigger a new alert +- Reassign, acknowledge, or resolve an alert +- Trigger alert actions +- Enable or disable an alert source +- Start immediate maintenance +- View services and their current status +- Access configured status pages ## Setup instructions @@ -49,17 +59,17 @@ import { // ... ``` -> To force an iLert card for each entity just add the `` component. An instruction card will appear if no integration key is set. +> To force an ilert card for each entity just add the `` component. An instruction card will appear if no integration key is set. -## Add iLert explorer to the app sidebar +## Add ilert explorer to the app sidebar Modify your app routes in [`App.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/App.tsx) to include the Router component exported by the plugin - for example: ```tsx -import { ILertPage } from '@backstage-community/plugin-ilert'; +import { IlertPage } from '@backstage-community/plugin-ilert'; // ... - } /> + } /> // ... ; ``` @@ -67,10 +77,10 @@ import { ILertPage } from '@backstage-community/plugin-ilert'; Modify your sidebar in [`Root.tsx`](https://github.com/backstage/backstage/blob/master/packages/app/src/components/Root/Root.tsx) to include the icon component exported by the plugin - for example: ```tsx -import { ILertIcon } from '@backstage-community/plugin-ilert'; +import { IlertIcon } from '@backstage-community/plugin-ilert'; // ... - + // ... ; ``` @@ -88,7 +98,7 @@ ilert: ## Providing the Authorization Header -In order to make the API calls, you need to provide a new proxy config which will redirect to the [iLert API](https://api.ilert.com/api-docs/) endpoint. It needs an [Authorization Header](https://api.ilert.com/api-docs/#section/Authentication). +In order to make the API calls, you need to provide a new proxy config which will redirect to the [ilert API](https://api.ilert.com/api-docs/) endpoint. It needs an [Authorization Header](https://api.ilert.com/api-docs/#section/Authentication). Add the proxy configuration in `app-config.yaml` diff --git a/workspaces/ilert/plugins/ilert/config.d.ts b/workspaces/ilert/plugins/ilert/config.d.ts index 99b556b28ae..383b05c87a0 100644 --- a/workspaces/ilert/plugins/ilert/config.d.ts +++ b/workspaces/ilert/plugins/ilert/config.d.ts @@ -16,7 +16,7 @@ export interface Config { ilert?: { /** - * Domain used by users to access iLert web UI. + * Domain used by users to access ilert web UI. * Example: https://my-app.ilert.com/ * @visibility frontend */ diff --git a/workspaces/ilert/plugins/ilert/package.json b/workspaces/ilert/plugins/ilert/package.json index 0e2fbef8662..53fc554c6d3 100644 --- a/workspaces/ilert/plugins/ilert/package.json +++ b/workspaces/ilert/plugins/ilert/package.json @@ -1,7 +1,7 @@ { "name": "@backstage-community/plugin-ilert", "version": "0.18.0", - "description": "A Backstage plugin that integrates towards iLert", + "description": "A Backstage plugin that integrates towards ilert", "backstage": { "role": "frontend-plugin", "pluginId": "ilert", diff --git a/workspaces/ilert/plugins/ilert/src/api/client.ts b/workspaces/ilert/plugins/ilert/src/api/client.ts index eb4bafb1b7f..2f9adefba21 100644 --- a/workspaces/ilert/plugins/ilert/src/api/client.ts +++ b/workspaces/ilert/plugins/ilert/src/api/client.ts @@ -83,7 +83,7 @@ export class ILertClient implements ILertApi { fetchApi: FetchApi; /** - * URL used by users to access iLert web UI. + * URL used by users to access ilert web UI. * Example: https://my-org.ilert.com/ */ baseUrl: string; @@ -382,7 +382,7 @@ export class ILertClient implements ILertApi { body: JSON.stringify({ start: dt.utc().toISO(), end: dt.utc().plus({ minutes }).toISO(), - description: `Immediate maintenance window for ${minutes} minutes. Backstage — iLert plugin.`, + description: `Immediate maintenance window for ${minutes} minutes. Backstage — ilert plugin.`, createdBy: 'Backstage', timezone: dt.local().zoneName, alertSources: [{ id: alertSourceId }], diff --git a/workspaces/ilert/plugins/ilert/src/components/Alert/AlertActionsMenu.tsx b/workspaces/ilert/plugins/ilert/src/components/Alert/AlertActionsMenu.tsx index adcef31ab03..84b133c4ded 100644 --- a/workspaces/ilert/plugins/ilert/src/components/Alert/AlertActionsMenu.tsx +++ b/workspaces/ilert/plugins/ilert/src/components/Alert/AlertActionsMenu.tsx @@ -199,7 +199,7 @@ export const AlertActionsMenu = ({ - View in iLert + View in ilert diff --git a/workspaces/ilert/plugins/ilert/src/components/AlertsPage/AlertsPage.tsx b/workspaces/ilert/plugins/ilert/src/components/AlertsPage/AlertsPage.tsx index 2d7002189a9..53c327df9fb 100644 --- a/workspaces/ilert/plugins/ilert/src/components/AlertsPage/AlertsPage.tsx +++ b/workspaces/ilert/plugins/ilert/src/components/AlertsPage/AlertsPage.tsx @@ -80,7 +80,7 @@ export const AlertsPage = () => { refetchAlerts={refetchAlerts} /> - This helps you to bring iLert into your developer portal. + This helps you to bring ilert into your developer portal. ( { <> { return ( - + diff --git a/workspaces/ilert/plugins/ilert/src/components/ILertPage/ILertPage.tsx b/workspaces/ilert/plugins/ilert/src/components/ILertPage/ILertPage.tsx index 18c0f551fb5..e5fb6ce2700 100644 --- a/workspaces/ilert/plugins/ilert/src/components/ILertPage/ILertPage.tsx +++ b/workspaces/ilert/plugins/ilert/src/components/ILertPage/ILertPage.tsx @@ -52,8 +52,8 @@ export const ILertPage = () => { return ( -
- +
+
{ - This helps you to bring iLert into your developer portal. + This helps you to bring ilert into your developer portal. { - View in iLert + View in ilert diff --git a/workspaces/ilert/plugins/ilert/src/components/ServicesPage/ServicesPage.tsx b/workspaces/ilert/plugins/ilert/src/components/ServicesPage/ServicesPage.tsx index b68939b88e2..3895f29220b 100644 --- a/workspaces/ilert/plugins/ilert/src/components/ServicesPage/ServicesPage.tsx +++ b/workspaces/ilert/plugins/ilert/src/components/ServicesPage/ServicesPage.tsx @@ -49,7 +49,7 @@ export const ServicesPage = () => { - This helps you to bring iLert into your developer portal. + This helps you to bring ilert into your developer portal. - View in iLert + View in ilert diff --git a/workspaces/ilert/plugins/ilert/src/components/StatusPagePage/StatusPagesPage.tsx b/workspaces/ilert/plugins/ilert/src/components/StatusPagePage/StatusPagesPage.tsx index f1b05f3afb0..078be4b1dbc 100644 --- a/workspaces/ilert/plugins/ilert/src/components/StatusPagePage/StatusPagesPage.tsx +++ b/workspaces/ilert/plugins/ilert/src/components/StatusPagePage/StatusPagesPage.tsx @@ -49,7 +49,7 @@ export const StatusPagesPage = () => { - This helps you to bring iLert into your developer portal. + This helps you to bring ilert into your developer portal.