Skip to content

Commit c6627c2

Browse files
add LFX mentorship project for ref docs generator (#1499)
Signed-off-by: Nate W <[email protected]> Co-authored-by: Nate W <[email protected]>
1 parent 1ed4fd5 commit c6627c2

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

programs/lfx-mentorship/2025/03-Sep-Nov/project_ideas.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,25 @@
6060
- Hongcai Ren (@RainbowMango, [email protected])
6161
- Upstream Issue: https://github.com/karmada-io/karmada/issues/6589
6262

63+
### Kubernetes
64+
65+
#### Improve Kubernetes Reference Docs Generator
66+
67+
- Description: The reference documentation for the Kubernetes API is generated at the end of every release cycle. Due to difficulties with the tools used to do this, and the state of that tool's documentation, intimate knowledge of how the tool works is required and generating the reference docs can only reliably be performed by one specific person. Currently, it is possible for the generator to fail at multiple points in the process. Many of these failures are entirely undocumented and without any error handling.
68+
- Expected Outcome: A measurable improvement in the usability of the reference docs generator, through some combination of an improvement in documentation, error handling, and code refactoring. It should be possible for other contributors to follow instructions and reliably produce the reference API docs, with solutions to any remaining common failure modes thoroughly documented.
69+
- Recommended Skills:
70+
- Go
71+
- Bash
72+
- Python
73+
- Technical Writing
74+
- Patience when faced with undocumented failure modes
75+
- Mentor(s):
76+
- Kat Cosgrove (@katcosgrove, [email protected])
77+
- Nate Waddington (@nate-double-u, [email protected])
78+
- Xander Grzywinski (@salaxander, [email protected])
79+
- Rey Lejano (@reylejano, [email protected])
80+
- Upstream Issue: https://github.com/kubernetes-sigs/reference-docs/issues/398
81+
6382
### WasmEdge
6483

6584
#### Pointer alignment checking for WASI host function arguments
@@ -142,4 +161,4 @@
142161
- Mentor(s):
143162
- Michael Yuan (@juntao, [email protected])
144163
- Sam Liu (@apepkuss, [email protected])
145-
- Upstream Issue: https://github.com/WasmEdge/WasmEdge/issues/4286
164+
- Upstream Issue: https://github.com/WasmEdge/WasmEdge/issues/4286

0 commit comments

Comments
 (0)