From f1dfea6e87383276eac2eef501579d93c6021162 Mon Sep 17 00:00:00 2001 From: Gabriela Cervantes Date: Wed, 21 Jun 2023 18:46:41 +0000 Subject: [PATCH] docs: Add metrics documentation reference This PR adds the metrics documentation as a general reference in the main README for kata containers. Signed-off-by: Gabriela Cervantes --- README.md | 4 ++++ tests/metrics/README.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index b531251943..7ea956d9d0 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,10 @@ The table below lists the remaining parts of the project: Kata Containers is now [available natively for most distributions](docs/install/README.md#packaged-installation-methods). +## Metrics tests + +See the [metrics documentation](tests/metrics/README.md). + ## Glossary of Terms See the [glossary of terms](https://github.com/kata-containers/kata-containers/wiki/Glossary) related to Kata Containers. diff --git a/tests/metrics/README.md b/tests/metrics/README.md index 436246031d..4e2d118700 100644 --- a/tests/metrics/README.md +++ b/tests/metrics/README.md @@ -1,5 +1,7 @@ # Kata Containers metrics +> **_Warning:_** Migration of metrics tests is WIP and you may not find all tests available here, but you can take a look at the [tests repo](https://github.com/kata-containers/tests/tree/main/metrics). + This directory contains the metrics tests for Kata Containers. The tests within this directory have a number of potential use cases: