From f25a8919fc92b5157fae0af5180e7627da199659 Mon Sep 17 00:00:00 2001 From: Nelson Kopliku Date: Wed, 12 Feb 2025 12:33:03 +0100 Subject: [PATCH] Adjust doc --- README.md | 29 +---------------------------- 1 file changed, 1 insertion(+), 28 deletions(-) diff --git a/README.md b/README.md index c5beadda5..79ec29c4a 100644 --- a/README.md +++ b/README.md @@ -14,24 +14,7 @@ Swagger UI is available at [trento-project.io/wanda/swaggerui](https://trento-pr # Developing Checks -Wanda architecture aims to simplify [testing Checks Executions](#testing-executions) and [adding new ones](#adding-new-checks). - -## Infrastructure - -For development purposes, a [docker-compose file](https://github.com/trento-project/wanda/blob/main/docker-compose.yaml) is provided. -The [docker-compose.checks.yaml](https://github.com/trento-project/wanda/blob/main/docker-compose.checks.yaml) provides additional configuration to start an environment for Checks development. - -### Starting a local environment - -Start the environment with: - -```bash -$ docker-compose -f docker-compose.checks.yaml up -d -``` - -Wanda is exposed on port `4000` and the API documentation is available at http://localhost:4000/swaggerui - -**Note** that the [message broker](https://www.rabbitmq.com/) **must** be reachable by Wanda and all the targets. +Please refer to [Trento Checks](https://github.com/trento-project/checks) and [testing Checks Executions](#testing-executions). ## Testing Executions @@ -225,16 +208,6 @@ Which would return the next where the `Value` is the available value in the writ } ``` -## Adding new Checks - -Built-in Checks can be found in the Catalog directory at `./priv/catalog/` - -To implement new checks and test them: - -- write a new [Check Specification](./guides/specification.md) file -- locate the newly created Check in the Catalog directory `./priv/catalog/` -- test the execution as [previously described](#testing-executions) - # Running a local Wanda instance ## Running a Development Environment