Clean up AutoOps notification settings page#6944
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
🔍 Preview links for changed docs |
Elastic Docs Style Checker (Vale)Summary: 3 warnings found
|
| File | Line | Rule | Message |
|---|---|---|---|
| deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md | 82 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md | 112 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
| deploy-manage/monitor/autoops/ec-autoops-notifications-settings.md | 131 | Elastic.MenuArrowsBold | Use '→' to separate menu items, not '' or '='. Example: Select Manage index → Add lifecycle policy. |
The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.
shainaraskas
left a comment
shainaraskas
left a comment
There was a problem hiding this comment.
cool, very thorough. I like the page structure.
couple of comments on depth and then some random style nits to consider, but lgtm :)
| 4. On the service **Integrations** tab, click **Add another integration**. | ||
| 5. Choose [Events API v2](https://developer.pagerduty.com/docs/events-api-v2-overview) (or add it during service creation). | ||
| 6. Expand the integration and copy the Integration key (also known as the routing key for Events API v2). | ||
| 5. select [Events API v2](https://developer.pagerduty.com/docs/events-api-v2-overview). |
There was a problem hiding this comment.
| 5. select [Events API v2](https://developer.pagerduty.com/docs/events-api-v2-overview). | |
| 5. Select [Events API v2](https://developer.pagerduty.com/docs/events-api-v2-overview). |
| 1. Go to [Slack API](https://api.slack.com/apps) | ||
| 2. Click **Create an App** > **From scratch**. | ||
| 3. Enter an app name and select your workspace, and then click **Create App**. | ||
| 4. From the left menu, select **Incoming Webhooks**. | ||
| 5. Turn on **Activate Incoming Webhooks**. | ||
| 6. Click **Request to Add New Webhook** and submit a request to your organization's admins. | ||
| 7. When your request is approved, select a Slack channel from the list of **Webhook URLs for Your Workspace** and click **Allow**. | ||
| 8. Copy the webhook URL. | ||
| 9. Store the URL securely. You will need it when configuring the connector in AutoOps. |
There was a problem hiding this comment.
there are lots of steps here that could age. is there a way to link off to official docs for the other product and then just indicate the key settings? this applies to all external procedures on this page.
| :::{dropdown} VictorOps | ||
|
|
||
| $$$ec-autoops-victorops$$$ | ||
| :::{dropdown} VictorOps |
There was a problem hiding this comment.
should this dropdown also have splunk on-call in it
| :name: ec-autoops-ms-configuration | ||
|
|
||
| $$$ec-autoops-ms-configuration$$$ | ||
| The Microsoft Teams integration consists of the following parts: |
There was a problem hiding this comment.
this pattern feels a little less than ideal to me because the second part is so far away from the colon. A more valuable intro would be something like "To set up the Microsoft Teams integration, you need to perform configurations in Microsoft Teams and AutoOps." or something
not too picky about this, just figure it's a good time to mention it because you're editing all of these lines
| **Microsoft Teams configuration** | ||
|
|
||
| Save the URL displayed during the creation of the incoming webhook, as you will use it during the AutoOps configuration. | ||
| 1. Follow Microsoft Teams' instructions to create an [incoming webhook](https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook). |
| * `AFFECTED_NODES`: List of affected nodes. | ||
| * `AFFECTED_INDICES`: List of affected indices. | ||
| * `EVENT_LINK`: Direct link to the event in AutoOps. | ||
| 4. Optionally, test the webhook integration by using the [webhook.site](https://webhook.site/#!/view/fe9d630e-2f01-44b7-9e41-ef9520fbe9a7). |
There was a problem hiding this comment.
are we opinionated about this tool? could we say "a webhook testing tool like webhook.site" ?
| 4. Optionally, test the webhook integration by using the [webhook.site](https://webhook.site/#!/view/fe9d630e-2f01-44b7-9e41-ef9520fbe9a7). | |
| 4. Optionally, test the webhook integration by using [webhook.site](https://webhook.site/#!/view/fe9d630e-2f01-44b7-9e41-ef9520fbe9a7). |
| ## Notifications report [ec-notification-report] | ||
|
|
||
| From the **Notifications** report, you can check all the notifications sent. The report lists all the events that were set up in the notification filters and provide their status. | ||
| From the **Notifications** report, you can check all the notifications sent. The report lists all the events that were set up in the notification filters and their status. |
There was a problem hiding this comment.
maybe?
| From the **Notifications** report, you can check all the notifications sent. The report lists all the events that were set up in the notification filters and their status. | |
| From the **Notifications** report, you can review all of the notifications that have been sent by AutoOps. The report lists all the events that were set up in the notification filters and their status. |
3 participants
Summary
When trying to fix broken anchor links on the Notification settings page, I realized some of the info was inconsistent/confusing. So I did some clean up and polished the page.
Closes #6940
Generative AI disclosure