Skip to content

Commit

Permalink
Update programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md
Browse files Browse the repository at this point in the history
Co-authored-by: Charles Uneze <charlesniklaus@gmail.com>
Signed-off-by: Sergey Kanzhelev <S.Kanzhelev@live.com>
  • Loading branch information
SergeyKanzhelev and network-charles committed Jul 26, 2024
1 parent 09f054d commit b6725b0
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions programs/lfx-mentorship/2024/03-Sep-Nov/project_ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit b6725b0

Please sign in to comment.