small changes to docs links

GabrielSalla · GabrielSalla · commit bfc13efe83f2 · 2026-02-14T17:41:52.000-03:00
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ A Sentinela Monitor is configured through 3 main parts, along some basic setting
 
 These implementations are enough for Sentinela to autonomously execute monitoring logic and automatically manages the issues.
 
-![sentinela example](./docs/images/example.gif)
+![sentinela example](/docs/images/example.gif)
 
 ## Example scenario: Pending orders with completed shipments
 Consider an online store where an order is expected to transition to `completed` as soon as its shipment is marked `completed`. Occasionally, inconsistencies arise: the shipment finishes but the order status remains stuck as `awaiting_delivery` or other intermediate state.
@@ -93,10 +93,10 @@ Sentinela provides a web dashboard, by default at port `8000`, with 2 sections:
 2. a monitor editor, where you can create and edit monitors directly from the browser
 
 **Overview**
-![dashboard overview](./docs/images/dashboard_overview.png)
+![dashboard overview](/docs/images/dashboard_overview.png)
 
 **Editor**
-![dashboard monitor editor](./docs/images/dashboard_editor.png)
+![dashboard monitor editor](/docs/images/dashboard_editor.png)
 
 # Documentation
 1. [Overview](/docs/overview.md)
@@ -107,15 +107,15 @@ Sentinela provides a web dashboard, by default at port `8000`, with 2 sections:
 4. [Validating a monitor](/docs/monitor_validating.md)
 5. [Registering a monitor](/docs/monitor_registering.md)
 6. Deployment
-    1. [Configuration](./docs/configuration.md)
-    2. [Configuration file](./docs/configuration_file.md)
-    3. [How to run](./docs/how_to_run.md)
-7. [Monitoring Sentinela](./docs/monitoring_sentinela.md)
-8. [Plugins](./docs/plugins/plugins.md)
-    1. [AWS](./docs/plugins/aws.md)
-    2. [Postgres](./docs/plugins/postgres.md)
-    3. [Slack](./docs/plugins/slack.md)
+    1. [Configuration](/docs/configuration.md)
+    2. [Configuration file](/docs/configuration_file.md)
+    3. [How to run](/docs/how_to_run.md)
+7. [Monitoring Sentinela](/docs/monitoring_sentinela.md)
+8. [Plugins](/docs/plugins/plugins.md)
+    1. [AWS](/docs/plugins/aws.md)
+    2. [Postgres](/docs/plugins/postgres.md)
+    3. [Slack](/docs/plugins/slack.md)
 9. Interacting with Sentinela
-    1. [HTTP server](./docs/http_server.md)
+    1. [HTTP server](/docs/http_server.md)
 10. Special cases
-    1. [Dropping issues](./docs/dropping_issues.md)
+    1. [Dropping issues](/docs/dropping_issues.md)
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -1,5 +1,5 @@
 # Configuration
-The basic configs are set through the `configs.yaml` file. This file is read when the application starts and all the settings will be loaded. The documentation found at [Configuration file](./configuration_file.md) provides an overview of the configuration parameters available.
+The basic configs are set through the `configs.yaml` file. This file is read when the application starts and all the settings will be loaded. The documentation found at [Configuration file](configuration_file.md) provides an overview of the configuration parameters available.
 
 The monitors path is also defined in the `configs.yaml` file. By default, it's set to the `example_monitors` folder, but it can be changed to another folder if desired. The `configs.yaml` file also have other configurations that can be adjusted.
 
diff --git a/docs/dropping_issues.md b/docs/dropping_issues.md
@@ -1,7 +1,7 @@
 # Dropping issues
 In some cases, a monitor may encounter edge cases where certain issues cannot be resolved automatically. While these edge cases should be considered during monitor development, dropping issues manually can serve as a solution for unavoidable situations.
 
-Issues can be dropped either via an [HTTP request](./http_server.md) or a [Slack message](./slack_commands.md).
+Issues can be dropped either via an [HTTP request](http_server.md) or a [Slack message](slack_commands.md).
 
 > [!IMPORTANT]
 > Since dropping issues is intended only for specific scenarios, issues IDs should be manually retrieved by querying the Sentinela application database.
diff --git a/docs/how_to_run.md b/docs/how_to_run.md
@@ -54,7 +54,7 @@ Local execution is recommended for developing monitors. It should not be used in
 
 When running the application locally, it is recommended to use the internal queue instead of the SQS queue for faster and smoother operation. However, it is also possible to use the AWS queue mock or a real SQS queue.
 
-1. Set the secrets in the `.env.secrets` file and environment variables in the `docker/docker-compose-local.yml` file, as specified in the [Configuration](./configuration.md) documentation.
+1. Set the secrets in the `.env.secrets` file and environment variables in the `docker/docker-compose-local.yml` file, as specified in the [Configuration](configuration.md) documentation.
 2. Migrate the database to the latest version. This is only necessary when running for the first time or after updates.
     ```shell
     make migrate-local
@@ -81,7 +81,7 @@ For a more scalable deployment, it is recommended to use separate containers for
 
 The `docker-compose` file for this setup includes a SQS queue mock, which is used by default. However, it is also possible to use the internal queue or a real SQS queue.
 
-1. Set the secrets in the `.env.secrets` file and environment variables in the `docker/docker-compose-scalable.yml` file, as specified in the [Configuration](./configuration.md) documentation.
+1. Set the secrets in the `.env.secrets` file and environment variables in the `docker/docker-compose-scalable.yml` file, as specified in the [Configuration](configuration.md) documentation.
 2. Set the `replicas` parameter in the `docker/docker-compose-scalable.yml` file to the desired number of executors.
 3. Migrate the database to the latest version. This is only necessary when running for the first time or after updates.
     ```shell
@@ -107,7 +107,7 @@ For production deployment, it is recommended to use a more complex setup with mu
 - Requires an external database and message queue.
 
 ### Building the Image
-The [Dockerfile](../Dockerfile) is a starting point for building the application image. This file implements the logic to install all dependencies for the enabled plugins.
+The [Dockerfile](/docker/Dockerfile) is a starting point for building the application image. This file implements the logic to install all dependencies for the enabled plugins.
 
 1. Install the dependencies for the application and enabled plugins.
     ```shell
@@ -123,9 +123,9 @@ The [Dockerfile](../Dockerfile) is a starting point for building the application
 ### Deploying the Application
 In production deployment, it is recommended to deploy the controller and executors in separate containers or pods (in the case of a Kubernetes deployment). This method requires an external queue to allow communication between the controller and executors. A persistent database is also recommended to prevent data loss.
 
-The files provided in the [Kubernetes template](../resources/kubernetes_template) directory can be used as a reference for a Kubernetes deployment.
+The files provided in the [Kubernetes template](/resources/kubernetes_template) directory can be used as a reference for a Kubernetes deployment.
 
-All services must have the environment variables set as specified in the [Configuration](./configuration.md) documentation.
+All services must have the environment variables set as specified in the [Configuration](configuration.md) documentation.
 
 Controllers and executors can be run by specifying them as parameters when starting the application:
 1. Run the controller.
diff --git a/docs/http_server.md b/docs/http_server.md
@@ -83,7 +83,7 @@ Enable the monitor with the provided `monitor_name`.
 
 Validate the monitor code provided without registering it.
 
-For more information, check the [Validating a monitor](./monitor_validating.md) documentation.
+For more information, check the [Validating a monitor](monitor_validating.md) documentation.
 
 Request body example:
 ```json
@@ -104,7 +104,7 @@ Response example:
 
 Register the monitor with the provided `monitor_name`.
 
-For more information, check the [Registering a monitor](./monitor_registering.md) documentation.
+For more information, check the [Registering a monitor](monitor_registering.md) documentation.
 
 Request body example:
 ```json
diff --git a/docs/monitor.md b/docs/monitor.md
@@ -1,5 +1,5 @@
 # Creating a new monitor
-This guide will walk through the steps to set up a new Monitor. The file [monitor_template.py](../resources/monitor_template.py) serves as a template for creating a new monitor. It includes all the necessary imports and settings to get started.
+This guide will walk through the steps to set up a new Monitor. The file [monitor_template.py](/resources/monitor_template.py) serves as a template for creating a new monitor. It includes all the necessary imports and settings to get started.
 
 As a demonstration, the Monitor that will be designed is intended to **search for users with invalid registration data**, specifically when their name is empty.
 
@@ -290,7 +290,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/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.
@@ -358,7 +358,7 @@ The available events are:
 The monitor utils module also provides useful functions for developing a monitor.
 
 ## Query
-The `query` function allows querying data from available databases. For more details, refer to the [Querying Databases](./querying.md) documentation.
+The `query` function allows querying data from available databases. For more details, refer to the [Querying Databases](querying.md) documentation.
 
 ## Read file
 The `read_file` function reads files in the same directory as the monitor code, making it useful for accessing other resources that the monitor relies on, such as SQL query files.
diff --git a/docs/monitor_registering.md b/docs/monitor_registering.md
@@ -1,7 +1,7 @@
 # Registering a monitor
 Once the monitor code has been created, it needs to be registered on Sentinela. The process for registering a new monitor or updating an existing one is the same.
 
-![Registering a monitor process](./images/monitor_register.png)
+![Registering a monitor process](images/monitor_register.png)
 
 ## Monitor Composition
 A monitor consists of:
diff --git a/docs/overview.md b/docs/overview.md
@@ -33,21 +33,21 @@ The Sentinela platform comprises four main components:
 - HTTP Server
 - Monitors Loader
 
-![Sentinela components](./images/components.png)
+![Sentinela components](images/components.png)
 
 ## Controller
 The controller orchestrates the processing of monitors, queuing them for execution as needed.
 
 The controller execution is demonstrated in the following diagram.
 
-![Controller execution](./images/controller.png)
+![Controller execution](images/controller.png)
 
 ## Executor
 The executor handles the actual execution of monitor routines, as well as responses to requests and events. It performs the platform’s core processing tasks and can be scaled horizontally to enhance processing capacity.
 
 The executor execution is demonstrated in the following diagram.
 
-![Executor execution](./images/executor.png)
+![Executor execution](images/executor.png)
 
 The executor will wait for a message in the queue and do nothing while none are available. When a message is received, the executor will process it using the correct handler.
 
@@ -61,16 +61,16 @@ During the handling of a message, the executor will continuously reset the messa
 ## HTTP Server
 As the name suggests, the HTTP server serves as an entry point for user requests and actions on the platform. While not all interactions must occur through the HTTP server, it provides a central access point for user actions.
 
-More information can be found in the [HTTP Server](./docs/http_server.md) documentation.
+More information can be found in the [HTTP Server](http_server.md) documentation.
 
 ## Monitors Loader
 The monitors loader loads the monitors from the database and registers them to be used by the other components.
 
-![Monitors loading process](./images/monitors_loading_process.png)
+![Monitors loading process](images/monitors_loading_process.png)
 
 The monitors loader execution is demonstrated in the following diagram.
 
-![Monitors loader execution](./images/monitors_loader.png)
+![Monitors loader execution](images/monitors_loader.png)
 
 The monitors loader registers internal and example monitors (if configured as such) to the database. This process is only executed when the controller is enabled in the execution to make sure only one instance is trying to register the same monitors.
 
diff --git a/docs/plugins/plugins.md b/docs/plugins/plugins.md
@@ -82,7 +82,7 @@ class MyNotification:
         ]
 ```
 
-The reaction functions must follow the same structure presented in the [Monitor](../monitor.md) documentation.
+The reaction functions must follow the same structure presented in the [Monitor](/docs/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.
@@ -139,7 +139,7 @@ __all__ = ["queues"]
 ```
 
 ## Pools
-Plugins can provide different database pools to be used by Sentinela. Pools are a way to provide connections to databases to the monitors through a simple interface using the `query` function. More information about querying databases can be found in the [querying](../querying.md) documentation.
+Plugins can provide different database pools to be used by Sentinela. Pools are a way to provide connections to databases to the monitors through a simple interface using the `query` function. More information about querying databases can be found in the [querying](/docs/querying.md) documentation.
 
 An example of a plugin that provides the a database pool is shown below:
 
@@ -179,9 +179,9 @@ When the databases are being initialized, Sentinela will search for pools provid
 
 ## Built-in plugins
 Sentinela comes with some built-in plugins that can be used to extend the application's functionality.
-- [AWS](./aws.md)
-- [Postgres](./postgres.md)
-- [Slack](./slack.md)
+- [AWS](aws.md)
+- [Postgres](postgres.md)
+- [Slack](slack.md)
 
 ## Enabling plugins
 To enable a plugin, set the `plugins` field in the configuration file with the name of the desired plugins.
diff --git a/docs/plugins/slack.md b/docs/plugins/slack.md
@@ -5,7 +5,7 @@ The Slack plugin offers an interface to interact with Sentinela through Slack. I
 To enable the Slack plugin, add `slack` to the `plugins` list in the configuration file.
 
 ## Create the Slack app
-First create a Slack app in your workspace. The provided app manifest [template](../resources/slack_app_manifest.yaml) has the basic configuration and permissions needed for the Sentinela Slack app.
+First create a Slack app in your workspace. The provided app manifest [template](/resources/slack_app_manifest.yaml) has the basic configuration and permissions needed for the Sentinela Slack app.
 
 ## Environment variables
 The following environment variables are used by the Slack plugin:
@@ -28,7 +28,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](/docs/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.
