From 50fb0a562e3fe5c53d1ab12716de1f775ac6e912 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 20 Dec 2017 17:39:10 +0000 Subject: [PATCH 1/4] doc: Add TOC to README Add a table of contents to the README to make navigation easier. Signed-off-by: James O. D. Hunt --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index b4da3cd84c..0ad63c9f64 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,13 @@ +* [About Kata Containers](#about-kata-containers) +* [Community](#community) + * [Contributor](#contributor) + * [Maintainer](#maintainer) +* [Governance](#governance) + * [Architecture Committee](#architecture-committee) + * [Working Committee](#working-committee) + # About Kata Containers Kata Containers is an open source project and community working to build a standard implementation of lightweight Virtual Machines (VMs) that feel and perform like containers, but provide the workload isolation and security advantages of VMs. From 6827a79c52f48658dbd012f37517003db2ddfb8f Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 20 Dec 2017 17:43:33 +0000 Subject: [PATCH 2/4] doc: Add project links to README Add in links to the Clear Containers and runv projects. Signed-off-by: James O. D. Hunt --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ad63c9f64..17fc2e0e2a 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Kata Containers is an open source project and community working to build a stand The Kata Containers project will initially comprise six components, including the Agent, Runtime, Proxy, Shim, Kernel and packaging of QEMU 2.9. It is designed to be architecture agnostic, run on multiple hypervisors and be compatible with the OCI specification for Docker containers and CRI-O for Kubernetes. -Kata Containers combines technology from Intel Clear Containers and Hyper runV. The code is hosted on Github under the Apache 2 license and the project is managed by the OpenStack Foundation. To learn more about the project and organizations backing the launch, visit www.katacontainers.io. +Kata Containers combines technology from [Intel® Clear Containers](https://github.com/clearcontainers/runtime) and [Hyper runV](https://github.com/hyperhq/runv). The code is hosted on Github under the Apache 2 license and the project is managed by the OpenStack Foundation. To learn more about the project and organizations backing the launch, visit https://www.katacontainers.io. # Community From ae2fd82edb37a7f049ff5adcdf8dc034bddc31c9 Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 20 Dec 2017 17:45:11 +0000 Subject: [PATCH 3/4] doc: Add Developers section Added a new "Developers" section and moved the existing "Contributor" and "Maintainer" sections below it. Signed-off-by: James O. D. Hunt --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 17fc2e0e2a..ccd96459b7 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,9 @@ * [About Kata Containers](#about-kata-containers) * [Community](#community) - * [Contributor](#contributor) - * [Maintainer](#maintainer) + * [Developers](#developers) + * [Contributor](#contributor) + * [Maintainer](#maintainer) * [Governance](#governance) * [Architecture Committee](#architecture-committee) * [Working Committee](#working-committee) @@ -20,13 +21,15 @@ Kata Containers combines technology from [Intel® Clear Containers](https://gith Kata Containers is working to build global, diverse and collaborative community. Anyone who is interested in supporting the technology is welcome to participate. We are seeking different expertise and skills, ranging from development, operations, documentation, marketing, community organization and product management. +## Developers + For code contributors, there are currently two roles relevant to project governance: -## Contributor +### Contributor A Contributor to the Kata Containers project is someone who has merged code within the last 12 months. Contributors are eligible to vote in the Architecture Committee elections. Contributors have read only access to the Kata Containers repos on Github. -## Maintainer +### Maintainer A Maintainer has the ability to merge code into the Kata Containers project. Maintainers are active Contributors and participants in the projects. In order to become a Maintainer, you must be nominated and approved by the established Maintainers. Maintainers have write access to the Kata Containers repos on Github. From a3afd525f0349b1bfc88c448d1d6718188f16a2e Mon Sep 17 00:00:00 2001 From: "James O. D. Hunt" Date: Wed, 20 Dec 2017 18:00:43 +0000 Subject: [PATCH 4/4] doc: Add Users section with install details Add a new "Users" section with pointers off to installation details for Clear Containers and runV. Fixes #2. Signed-off-by: James O. D. Hunt --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index ccd96459b7..de53c53280 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ * [About Kata Containers](#about-kata-containers) * [Community](#community) + * [Users](#users) + * [Installing Clear Containers](#installing-clear-containers) + * [Installing runV](#installing-runv) * [Developers](#developers) * [Contributor](#contributor) * [Maintainer](#maintainer) @@ -21,6 +24,25 @@ Kata Containers combines technology from [Intel® Clear Containers](https://gith Kata Containers is working to build global, diverse and collaborative community. Anyone who is interested in supporting the technology is welcome to participate. We are seeking different expertise and skills, ranging from development, operations, documentation, marketing, community organization and product management. +## Users + +Since Kata Containers does not yet provide an installation option, the current +advice for users is to install either Clear Containers or runV since both +projects will provide a migration path to Kata Containers at a later date. + +If you do not already have an installation of either project, Clear Containers +may be the simplest option as packages for commont Linux* distributions are +provided. However, your choice may depend on the particular project features +that interest you. + +### Installing Clear Containers + +See https://github.com/clearcontainers/runtime/wiki/Installation. + +### Installing runV + +See https://github.com/hyperhq/runv. + ## Developers For code contributors, there are currently two roles relevant to project governance: