Skip to content

Docs fixes #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GabrielSalla merged 1 commit into from
May 24, 2025
Merged

Docs fixes #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/monitor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ result = await asyncio.to_thread(blocking_function)
# Notifications
Notifications are optional and can be configured to send notifications to different targets without needing extensive settings for ech monitor. Configure notifications by creating the `notification_options` variable with a list of the desired notifications. Each notification has it's own settings and behaviors.

Notifications are provided as plugins. Check the [plugins documentation](./plugins.md) for more information.
Notifications are provided as plugins. Check the [plugins documentation](./plugins/plugins.md) for more information.

# Reactions
Reactions are optional and can be configured reactions to specific events by creating a `reaction_options` variable with an instance of the `ReactionOptions` class, available in the `monitor_utils` module.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ class MyNotification:
]
```

The reaction functions must follow the same structure presented in the [Monitor](./monitors.md) documentation.
The reaction functions must follow the same structure presented in the [Monitor](../monitor.md) documentation.

## Services
Services are used when the plugin has some initialization or running service. An example of a running service is a websocket connection to an external provider.
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/slack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Possible buttons:
- **Lock**: Lock the alert. Visible if the alert is not already locked.
- **Solve**: Solves the alert. Visible only if the monitor’s issue settings is set as **not solvable**.

![Slack message with buttons](./images/slack_notification_message_with_buttons.png)
![Slack message with buttons](../images/slack_notification_message_with_buttons.png)

### Messages mentioning Sentinela
As a Slack app, Sentinela can also respond to direct commands sent in a message. To interact this way, mention the Sentinela app, followed by the desired action.
Expand Down