From b02d87de2620cc04243a049781dc4d651ed1b8b1 Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Thu, 28 Nov 2024 12:52:20 +0900 Subject: [PATCH] docs: Add description and fix title Signed-off-by: Arisu Tachibana --- docs/_index.md | 3 +-- docs/checkout.md | 3 +-- docs/results.md | 3 +-- docs/testretry.md | 3 +-- 4 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/_index.md b/docs/_index.md index 5ba7254..06c5e2b 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -1,10 +1,9 @@ +++ title = 'kci-dev' date = 2024-01-14T07:07:07+01:00 +description = 'Tool for interact programmatically with KernelCI instances.' +++ -# kci-dev - kci-dev is a cmdline tool for interact with a enabled KernelCI server Purpose of this tool to provide a easy way to use features of KernelCI Pipeline instance. diff --git a/docs/checkout.md b/docs/checkout.md index d10ea6f..268638c 100644 --- a/docs/checkout.md +++ b/docs/checkout.md @@ -1,10 +1,9 @@ +++ title = 'checkout' date = 2024-01-14T07:07:07+01:00 +description = 'This command allow to test arbitary commit on the KernelCI Pipeline instance.' +++ -## checkout - This command allow to test arbitary commit on the KernelCI Pipeline instance. This might be useful in several cases: - You want to test a specific commit, if it fails or pass test, or introduce any other degradation comparing to the current, or another commit. - You want to create snapshot of the test results on specific tags (releases, etc). diff --git a/docs/results.md b/docs/results.md index d1a6747..e19da82 100644 --- a/docs/results.md +++ b/docs/results.md @@ -1,10 +1,9 @@ +++ title = 'results' date = 2024-01-14T07:07:07+01:00 +description = 'Command for show test results.' +++ -### results - This command will show the test result by node id. Example: diff --git a/docs/testretry.md b/docs/testretry.md index 0d4009f..3742429 100644 --- a/docs/testretry.md +++ b/docs/testretry.md @@ -1,10 +1,9 @@ +++ title = 'testretry' date = 2024-01-14T07:07:07+01:00 +description = 'Command for retry failed tests.' +++ -### testretry - This command will retry the failed tests. In some cases tests may fail due to network issues, hardware problems, nature of test (flaky), etc. This command will retry the failed tests, and create additional test jobs for the failed tests. After observing the results, you can decide if test results were reliable, not, or maybe even test need improvement.