From f5adb38bd860a92abcc42c8420c0c2c1a324b2ff Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Fri, 19 Apr 2024 08:48:39 -0400 Subject: [PATCH] README.md: Line wrap long sections This is mostly just a trivial change to demonstrate merge automation with Mergify that we just turned on. Signed-off-by: Russell Bryant --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ac8da08a..93f6a4da 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,18 @@ Our goal is to implement a GitHub bot that will: - Automate major portions of the test and review workflow for taxonomy PRs. - Stash the generated data and trained models and make them available for download. - Have the capacity to serve these models for testing purposes. -- Have a way to monitor the system's state -- what builds are available for each PR, what jobs are in progress, etc … +- Have a way to monitor the system's state -- what builds are available for each + PR, what jobs are in progress, etc … - Contributor / Triager - status via GitHub PR comments from the bot - Admin - OTEL, Grafana, etc … ### Current Status -The current iteration is focused on automating the `ilab generate` portion of the workflow. The following diagram shows the architecture of the bot and its supporting infrastructure. It supports scaling a pool of workers to run `ilab generate` jobs. The workers can be located anywhere and will be connect to Redis over a private mesh network managed by [Nexodus](https://nexodus.io). +The current iteration is focused on automating the `ilab generate` portion of +the workflow. The following diagram shows the architecture of the bot and its +supporting infrastructure. It supports scaling a pool of workers to run `ilab +generate` jobs. The workers can be located anywhere and will be connect to Redis +over a private mesh network managed by [Nexodus](https://nexodus.io). [![Instruct Lab Bot Architecture](./docs/bot-arch.png)](./docs/bot-arch.png) @@ -39,9 +44,12 @@ The current GitHub workflow in a PR is: ## Contributing -If you have suggestions for how instructlab-bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions. +If you have suggestions for how instructlab-bot could be improved, or want to +report a bug, open an issue! We'd love all and any contributions. -For more, check out the [InstructLab Bot Contribution Guide](CONTRIBUTING.md) and [InstructLab Community](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md). +For more, check out the [InstructLab Bot Contribution Guide](CONTRIBUTING.md) +and [InstructLab +Community](https://github.com/instructlab/community/blob/main/CONTRIBUTING.md). ## License