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 bc962d79..60576ba6 100644 --- a/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md +++ b/programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md @@ -39,7 +39,7 @@ #### Improve documentation build infrastructure - Description: The build infrastructure for istio.io currently carries a complete archived copy of the site for each release of Istio. These archived versions should be separated to their own branch, with only the supported versions published. We should also separate out content which is not version-specific (e.g. the home page, news and blogs) so that only the latest version of this content is visible online. -- Expected Outcome: Updated publishing infrastructure for istio.io which separates evergreen content (home page, blogs) with versioned content (documentation). Drop-downs per docs page allow switching between the supported versions. +- Expected Outcome: Updated publishing infrastructure for istio.io which separates evergreen content (home page, blogs) with versioned content (documentation). Drop-downs per docs page allow switching between the supported versions. - Recommended Skills: Systems engineering, scripting, programming (Go/Bash), Hugo templating - Mentor(s): - Craig Box (@craigbox, craig.box AT gee-mail) @@ -429,3 +429,17 @@ Expected Outcome: Gadget developers have a way to run unit tests in different ke - Florent Poinsard (@frouioui, florent@planetscale.com) - Matt Lord (@mattlord, mlord@planetscale.com) - Upstream Issue: https://github.com/vitessio/website/issues/1798 + + +### Kubernetes + +#### Testeable 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. +- Mentor(s): + - Sergey Kanzhelev (@SergeyKanzhelev, S.Kanzhelev@live.com) + - Tim Allclair (@tallclair, TODO) +- Upstream Issue: https://github.com/kubernetes/kubernetes/issues/126369 +