From f957b5a3beb8d5409990be19badf8e936f299950 Mon Sep 17 00:00:00 2001 From: Javed Habib Date: Thu, 19 Dec 2024 20:23:12 +0530 Subject: [PATCH] chore: readme fix --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 82b2ad3..0c9bfea 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ environments composed of GA4GH TES nodes. proTES gateway may serve as a crucial component in federated compute networks based on the GA4GH Cloud ecosystem. Its primary purpose is to provide -centralized features to a federated network of independently operated GA4GH TES +centralized features to a federated network of independently operated GA4GH TES instances. As such, it can serve, for example, as a compatibility layer, a load balancer workload distribution layer, a public entry point to an enclave of independent compute nodes, or a means of collecting telemetry. @@ -38,9 +38,9 @@ proof-of-concept examples for different task distribution scenarios: evenly (actually: randomly!) distributes workloads across a network of TES endpoints * **Bringing compute to the data**: The - `pro_tes.middleware.task_distribution.distance` plugin selects TES endpoints + `pro_tes.middleware.task_distribution.distance` plugin selects TES endpoints to relay incoming requests to in such a way that the distance the (input) data - of a task has to travel across the network of TES endpoints is minimized. + of a task has to travel across the network of TES endpoints is minimized. ### Implementation notes @@ -76,7 +76,7 @@ Ensure you have the following software installed: ### Prerequisites -Create data directory and required subdiretories +Create data directory and required subdirectories ```bash export PROTES_DATA_DIR=/path/to/data/directory @@ -135,7 +135,7 @@ interactions with the community. ## Versioning -The project adopts the [semantic versioning][semver] scheme for versioning. +The project adopts the [semantic versioning][res-sem-ver] scheme for versioning. Currently the service is in beta stage, so the API may change and even break without further notice. However, once we deem the service stable and "feature complete", the major, minor and patch version will shadow the supported TES @@ -174,22 +174,19 @@ thread in our [Q&A forum][contact-qa], or send us an [email][contact-email]. [docs-contributing]: [docs-deploy]: deployment/README.md [docs-license]: LICENSE -[GA4GH TES OpenAPI specification]: [image-protes-overview]: [res-celery]: -[res-connexion]: [res-docker]: [res-docker-compose]: [res-elixir-cloud-aai]: [res-flask]: [res-foca]: [res-ga4gh]: -[res-ga4gh-cloud]: [res-ga4gh-tes]: [res-git]: [res-helm]: [res-kubernetes]: -[res-mondodb]: -[res-ouath2]: +[res-mongodb]: +[res-oauth2]: [res-rabbitmq]: [res-sem-ver]: