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 :)
| 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.
There was a problem hiding this comment.
I considered this, but unfortunately not all the external products have clear documentation about this. I've replaced some sections with external links, but the rest of them will have to stay
| :::{dropdown} VictorOps | ||
|
|
||
| $$$ec-autoops-victorops$$$ | ||
| :::{dropdown} VictorOps |
There was a problem hiding this comment.
should this dropdown also have splunk on-call in it
There was a problem hiding this comment.
I opted not to add it because the UI just says "VictorOps"
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