docs: Add a README #32
Conversation
jodh-intel
force-pushed
the
add-readme
branch
from
2ceeb7e
to
9cccc6f
Compare
Add a general `README.md` which also explains the usage of the important `KATA_DEV_MODE` variable. Fixes kata-containers#31. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
jodh-intel
force-pushed
the
add-readme
branch
from
9cccc6f
to
54665c1
Compare
|
Hi @bergwolf, @grahamwhaley, @klynnrif - could you take a look please? |
|
lgtm |
|
Oops - merged as I got mesmerised by the big green button! ;) It looks like we need to add a pullapprove doc team approval requirement to all the repos... |
There was a problem hiding this comment.
I took a look here and have a few suggested rewrites. My feelings aren't too hurt @jodh-intel ;) haha. Thanks!
| ## CI Content | ||
|
|
||
| This repository contains a [number of scripts](https://github.com/kata-containers/tests/tree/master/.ci) | ||
| designed to be run from under a "CI" (Continuous Integration) system. |
There was a problem hiding this comment.
that run from under a "CI" (Continuous Integration) system.
|
|
||
| ### Centralised scripts | ||
|
|
||
| The CI scripts in this repository are used for testing changes to the content |
There was a problem hiding this comment.
Lines 27-29 suggested rewrite: The CI scripts in this repository are used to test changes to the content of this repository. These scripts are also used by the other Kata Containers code repositories.
| - Functionality is defined once. | ||
| - Easy to make changes affecting all code repositories centrally. | ||
|
|
||
| - Assurance that all the code repositories are being tested in the same way |
There was a problem hiding this comment.
Assurance that all the code repositories are tested in this same way
|
|
||
| WARNING: | ||
|
|
||
| The CI scripts need to perform a lot of setup before running content under a |
There was a problem hiding this comment.
The CI scripts perform a lot of setup before running content under a
|
|
||
| ### Detecting a CI system | ||
|
|
||
| The strategy for checking if the tests are running under a CI system is to see |
There was a problem hiding this comment.
The strategy to check if the tests are running under a CI system is to see
| explained in [CI Setup](#ci-setup), running *all* the content in this | ||
| repository could be dangerous. | ||
|
|
||
| The recommended approach to resolving this issue is to set the variable below |
There was a problem hiding this comment.
The recommended approach to resolve this issue is to set the following variable
|
|
||
| Setting this variable has the following effects: | ||
|
|
||
| - Disables content that may not be safe for developers to run locally. |
There was a problem hiding this comment.
Disables content that might not be...
Apply the doc teams review changes that got missed off PR kata-containers#32. Fixes kata-containers#34. Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
Add a general
README.mdwhich also explains the usage of theimportant
KATA_DEV_MODEvariable.Fixes #31.
Signed-off-by: James O. D. Hunt james.o.hunt@intel.com