Skip to content

Commit

Permalink
Merge pull request #50 from aliceinwire/gohugo
Browse files Browse the repository at this point in the history
docs: Add description and fix title
  • Loading branch information
aliceinwire authored Nov 28, 2024
2 parents fbb2e62 + b02d87d commit c668c91
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
3 changes: 1 addition & 2 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
3 changes: 1 addition & 2 deletions docs/checkout.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
3 changes: 1 addition & 2 deletions docs/results.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 1 addition & 2 deletions docs/testretry.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit c668c91

Please sign in to comment.