From 150c40b5b19b5b64b937a19a229d8f64a58d2afc Mon Sep 17 00:00:00 2001 From: Joe Bowbeer Date: Sun, 9 Oct 2022 12:37:50 -0700 Subject: [PATCH] docs: Improve Automated/Manual documentation (#1298) * docs: improve Automated/Manual documentation * sic --- docs/flags-and-commands.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/flags-and-commands.md b/docs/flags-and-commands.md index d00d9ab..69a9888 100644 --- a/docs/flags-and-commands.md +++ b/docs/flags-and-commands.md @@ -112,7 +112,8 @@ There are four output states: - [INFO] is informational output that needs no further action. Note: -- If the test is Manual, this always generates WARN (because the user has to run it manually) +- Some tests with `Automated` in their description must still be run manually +- If the user has to run a test manually, this always generates WARN - If the test is Scored, and kube-bench was unable to run the test, this generates FAIL (because the test has not been passed, and as a Scored test, if it doesn't pass then it must be considered a failure). - If the test is Not Scored, and kube-bench was unable to run the test, this generates WARN. - If the test is Scored, type is empty, and there are no `test_items` present, it generates a WARN. This is to highlight tests that appear to be incompletely defined.