From 874d16a4e1352705f21b5abcd34a79bc99f7eaae Mon Sep 17 00:00:00 2001 From: Lenka Bocincova Date: Tue, 3 Jan 2023 13:25:09 +0100 Subject: [PATCH] Adding more info to Contribute section Signed-off-by: Lenka Bocincova --- index.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/index.md b/index.md index 45930cf..51e2653 100755 --- a/index.md +++ b/index.md @@ -38,7 +38,7 @@ Join #crio on [Kubernetes Slack](https://slack.k8s.io/) To install on the following operating systems, set the environment variable `$OS` as the appropriate field in the following table: | Operating system | $OS | -| ---------------- | ----------------- | +|------------------|-------------------| | Centos 8 | `CentOS_8` | | Centos 8 Stream | `CentOS_8_Stream` | | Centos 7 | `CentOS_7` | @@ -58,7 +58,7 @@ yum install cri-o To install on the following operating systems, set the environment variable `$OS` as the appropriate field in the following table: | Operating system | $OS | -| ---------------- | ----------------- | +|------------------|-------------------| | Debian Unstable | `Debian_Unstable` | | Debian Testing | `Debian_Testing` | | Ubuntu 20.04 | `xUbuntu_20.04` | @@ -112,7 +112,7 @@ It is a lightweight alternative to using Docker, Moby or rkt as the runtime for * {:.contributor} IBM CRI-O is developed by maintainers and contributors from these companies and others. -It is a community-driven, open source project. Feedback, users, and of course, contributors, are always welcome via the [cri-o/cri-o](https://github.com/cri-o/cri-o) GitHub project. +It is a community-driven, open source project. Feedback, users, and of course, contributors, are always welcome via the [cri-o/cri-o](https://github.com/cri-o/cri-o) GitHub project. If you would like to contribute for the first time, check the Contribute section below. ## Architecture @@ -128,7 +128,7 @@ The architectural components are as follows: - After the rootfs has been created for the container, CRI-O generates an OCI runtime specification json file describing how to run the container using the OCI Generate tools. - CRI-O then launches an OCI Compatible Runtime using the specification to run the container proceses. The default OCI Runtime is runc. - Each container is monitored by a separate `conmon` process. The conmon process holds the `pty` of the PID1 of the container process. It handles logging for the container and records the exit code for the container process. -- Networking for the pod is setup through use of [CNI](https://github.com/containernetworking/cni), so any CNI plugin can be used with CRI-O. +- Networking for the pod is set up through use of [CNI](https://github.com/containernetworking/cni), so any CNI plugin can be used with CRI-O. ## Components @@ -176,12 +176,18 @@ situations. Container security separation policies are provided by a series of tools including SELinux, Capabilities, seccomp, and other security separation policies as specified in the OCI Specification. -### Contribute +## Contribute + +Join the CRI-O community with other users and contributors - whether you want to ask questions, report issues, submit pull requests, be a reviewer, help with documentation, improve our website, or write a blog post, we always welcome new members. For more guidance on how to contribute, please see the [**contributing guide**](https://github.com/cri-o/cri-o/blob/main/CONTRIBUTING.md). You can find us at: -- [GitHub](https://github.com/cri-o/cri-o) -- Slack: [Kubernetes](https://slack.k8s.io/) #crio +* [**GitHub**](https://github.com/cri-o/cri-o) - For discussions around issues/bugs and features, you can use the GitHub issues and PRs tracking system. +* **Slack: [Kubernetes](https://slack.k8s.io/) #crio** - For general questions, or discussions, please use our channel on the Kubernetes slack. +* [**Bi-weekly community meetings**](https://github.com/cri-o/cri-o/wiki/CRI-O-Weekly-Meeting) - A place for CRI-O contributors and stakeholders to chat about the latest and greatest CRI-O work happening, and ask questions. + +### Other resources +Learn more about CRI-O from [different articles, videos, podcasts and tutorials](https://github.com/cri-o/cri-o/blob/main/awesome.md) that our community put together. \ No newline at end of file