From b6725b023442028c029f235b0d87e21cc10ffb1b Mon Sep 17 00:00:00 2001 From: Sergey Kanzhelev Date: Fri, 26 Jul 2024 10:20:24 -0700 Subject: [PATCH] Update programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md Co-authored-by: Charles Uneze Signed-off-by: Sergey Kanzhelev --- programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md b/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md index a4e26ccb..a5900316 100644 --- a/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md +++ b/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md @@ -332,11 +332,11 @@ Expected Outcome: Gadget developers have a way to run unit tests in different ke ### Kubernetes -#### Testeable documentation for the Pod Lifecycle events +#### Testable documentation for the Pod Lifecycle events -- Description: Kubernetes Pods are the unit of execution. Pods's API surface is limited, but yet presenting many challenges for people authoring complex behaviors like proper graceful termination, probes, or advances initialization behaviors. Documentation and testing of those scenarios is limited. The misunderstanding of pod lifecycle and edge casesoften lead to reliability issues in Pods. Lately there were limited efforts to document and test those behaviors. Creating a skaffolding to document and test those behaviors will help temendously the Kubernetes project as well as end users. -- Expected Outcome: Skaffolding in https://github.com/kubernetes/website/ to add new pod lifecycle behavios descriptions. Tests for those edge cases. And cross linking between tests and documentation. -- Recommended Skills: familiarity with Golang, some knowledge about the K8s and containers, understanding of Hugo is a plus. +- Description: Kubernetes Pods are the unit of execution. Pods's API surface is limited, but yet presenting many challenges for people authoring complex behaviors like proper graceful termination, probes, or advances initialization behaviors. Documentation and testing of those scenarios is limited. The misunderstanding of pod lifecycle and edge cases often lead to reliability issues in Pods. Lately there were limited efforts to document and test those behaviors. Creating a skaffolding to document and test those behaviors will tremendously help the Kubernetes project as well as end users. +- Expected Outcome: Skaffolding in https://github.com/kubernetes/website/ to add new pod lifecycle behavior descriptions. Tests for those edge cases. And cross linking between tests and documentation. +- Recommended Skills: Familiarity with Golang, some knowledge about the K8s and containers, understanding of Hugo is a plus. - Mentor(s): - Sergey Kanzhelev (@SergeyKanzhelev, S.Kanzhelev@live.com) - Tim Allclair (@tallclair, TODO)