From ca0b5bdaa08aaba4b9c0e2b18c90b1ef73fb0d67 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 31 May 2019 09:19:20 +0100 Subject: [PATCH] CI: Improve README Add links to the scripts the README summarises (where possible). Fixes: #1656. Signed-off-by: James O. D. Hunt --- .ci/README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.ci/README.md b/.ci/README.md index ce1785f01..641717f1c 100644 --- a/.ci/README.md +++ b/.ci/README.md @@ -16,20 +16,20 @@ This directory contains scripts used by the [Kata Containers](https://github.com | Script(s) | Description | | -- | -- | -| `go-test.sh` | Central interface to the `golang` `go test` facility. | +| [`go-test.sh`](go-test.sh) | Central interface to the `golang` `go test` facility. | | `install_*` | Install various parts of the system and dependencies. | -| `jenkins_job_build.sh` | Called by the [Jenkins CI](https://github.com/kata-containers/ci) to trigger a CI run. | -| `kata-arch.sh` | Displays architecture name in various formats. | -| `kata-doc-to-script.sh` | Convert a [GitHub-Flavoured Markdown](https://github.github.com/gfm) document to a shell script. | -| `kata-find-stale-skips.sh` | Find skipped tests that can be unskipped. | -| `kata-simplify-log.sh` | Simplify a logfile to make it easer to `diff(1)`. | -| `lib.sh` | Library of shell utilities used by other scripts. | -| `run_metrics_PR_ci.sh` | Run various performance metrics on a PR. | -| `run.sh` | Run the tests in a CI environment. | +| [`jenkins_job_build.sh`](jenkins_job_build.sh) | Called by the [Jenkins CI](https://github.com/kata-containers/ci) to trigger a CI run. | +| [`kata-arch.sh`](kata-arch.sh) | Displays architecture name in various formats. | +| [`kata-doc-to-script.sh`](kata-doc-to-script.sh) | Convert a [GitHub-Flavoured Markdown](https://github.github.com/gfm) document to a shell script. | +| [`kata-find-stale-skips.sh`](kata-find-stale-skips.sh) | Find skipped tests that can be unskipped. | +| [`kata-simplify-log.sh`](kata-simplify-log.sh) | Simplify a logfile to make it easer to `diff(1)`. | +| [`lib.sh`](lib.sh) | Library of shell utilities used by other scripts. | +| [`run_metrics_PR_ci.sh`](run_metrics_PR_ci.sh) | Run various performance metrics on a PR. | +| [`run.sh`](run.sh) | Run the tests in a CI environment. | | `setup_env_*.sh` | Distro-specific setup scripts. | -| `setup.sh` | Setup the CI environment. | -| `static-checks.sh` | Central static analysis script. | -| `teardown.sh` | Tasks to run at the end of a CI run. | +| [`setup.sh`](setup.sh) | Setup the CI environment. | +| [`static-checks.sh`](static-checks.sh) | Central static analysis script. | +| [`teardown.sh`](teardown.sh) | Tasks to run at the end of a CI run. | ## Script conventions