From 98844e931ee4b4f5baf581ea6a30d37f768792fe Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 2 Feb 2018 09:42:31 +0000 Subject: [PATCH 1/3] docs: Remove unecessary backticks Remove backticks from repos that are not the name of files/commands. Also, mark first instance of "Linux" with asterisk. Signed-off-by: James O. D. Hunt --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 24b015d060..e7732f0343 100644 --- a/README.md +++ b/README.md @@ -97,16 +97,16 @@ create virtual machines for hosting the containers. ##### Kernel -The [`linux`](https://github.com/kata-containers/linux) kernel is used by the hypervisor to boot the guest image. +The [Linux\*](https://github.com/kata-containers/linux) kernel is used by the hypervisor to boot the guest image. ### Documentation -The [`documentation`](https://github.com/kata-containers/documentation) +The [documentation](https://github.com/kata-containers/documentation) repository hosts documentation common to all code components. ### Test code -The [Tests](https://github.com/kata-containers/tests) repository hosts all +The [tests](https://github.com/kata-containers/tests) repository hosts all test code except the unit testing code (which is kept in the same repository as the component it tests). From 09373bd2b40ad784d3b695b60de9a3df55568013 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 2 Feb 2018 10:15:37 +0000 Subject: [PATCH 2/3] docs: Fix anchor for osbuilder The HTML anchor generated by github for "osbuilder" wasn't working, so removed the slash from the title. Signed-off-by: James O. D. Hunt --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e7732f0343..f6a8a2d47f 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ * [Documentation](#documentation) * [Test code](#test-code) * [Utilities](#utilities) - * [O/S builder](#o/s-builder) + * [OS builder](#os-builder) * [Web content](#web-content) --- @@ -112,7 +112,7 @@ as the component it tests). ### Utilities -#### O/S builder +#### OS builder The [osbuilder](https://github.com/kata-containers/osbuilder) tool can create a rootfs and a "mini O/S" image. This image is used by the hypervisor to setup From d524e7adf5270f52c25f9af78caf7883c5f6350b Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Fri, 2 Feb 2018 09:45:05 +0000 Subject: [PATCH 3/3] docs: Add references to "ci" and "packaging" repos Add brief details of the new "ci" and "packaging" repositories. Fixes #6. Signed-off-by: James O. D. Hunt --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index f6a8a2d47f..0b00ea69ab 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,10 @@ * [Additional](#additional) * [Hypervisor](#hypervisor) * [Kernel](#kernel) + * [CI](#ci) * [Community](#community) * [Documentation](#documentation) + * [Packaging](#packaging) * [Test code](#test-code) * [Utilities](#utilities) * [OS builder](#os-builder) @@ -48,6 +50,11 @@ issues](https://github.com/kata-containers/kata-containers/issues/new): ## Kata Containers repositories +### CI + +The [CI](https://github.com/kata-containers/ci) repository stores Continuous +Integration (CI) system configuration information. + ### Community The [Community](https://github.com/kata-containers/community) repository is @@ -104,6 +111,13 @@ The [Linux\*](https://github.com/kata-containers/linux) kernel is used by the hy The [documentation](https://github.com/kata-containers/documentation) repository hosts documentation common to all code components. +### Packaging + +The [packaging](https://github.com/kata-containers/packaging) repository is +used for creating packages for [system +components](#kata-containers-developed-components) including +[rootfs](#os-builder) and [kernel](#kernel) images. + ### Test code The [tests](https://github.com/kata-containers/tests) repository hosts all