SIG Docs Annual Report 2024 (#8336)
* update sig docs annual report * updates annual report
This commit is contained in:
Kat Cosgrove
GitHub
parent
ff98a41642
commit
76f523a957
|
|
@ -1,64 +1,20 @@
|
|||
# 2024 Annual Report: SIG Docs
|
||||
***1. What work did the SIG do this year that should be highlighted?***
|
||||
* Karen Bradshaw, Tim Bannister, and Taylor Dolezal stepped down as SIG Docs Tech Leads. Kat Cosgrove and Xander Grzywinski were appointed as new Tech Leads.
|
||||
* While not a success, SIG Docs took 2024 to explore options around translation tooling for localizations, however, staffing changes meant it couldn't be prioritized in time. The `localization` subproject will own this exploration for 2025 and beyond.
|
||||
|
||||
## Current initiatives and Project Health
|
||||
***2. Are there any areas and/or subprojects that your group needs help with (e.g. fewer than 2 active OWNERS)?***
|
||||
* We continue to require help with the `kubernetes-blog` subproject. While we have separated tasks based on needs for release blogs and general blog posts, our blog team still needs more staff.
|
||||
* The `reference-docs` subproject is slowly being revived, with some refactoring planned to bring on more contributors. Kat Cosgrove and Xander Grzywinski, our new Tech Leads, will be elevated to OWNERS.
|
||||
* As part of our [annual updation of the OWNERS file](https://github.com/kubernetes/website/pull/49273), we found that two of our localisations are at risk due to there being only one active approver/reviewer. SIG leads [have requested](https://kubernetes.slack.com/archives/C0191RDKHU1/p1739338503630329?thread_ts=1735797874.143339&cid=C0191RDKHU1) the localisation subproject leads to reach out to the respective localisations and also, feature this as a discussion item in the upcoming localisation meeting to understand how to better support them.
|
||||
|
||||
1. What work did the SIG do this year that should be highlighted?
|
||||
|
||||
<!--
|
||||
Some example items that might be worth highlighting:
|
||||
- Major KEP advancement
|
||||
- Important initiatives that aren't tracked via KEPs
|
||||
- Paying down significant tech debt
|
||||
- Governance and leadership changes
|
||||
-->
|
||||
|
||||
2. Are there any areas and/or subprojects that your group needs help with (e.g. fewer than 2 active OWNERS)?
|
||||
|
||||
|
||||
3. Did you have community-wide updates in 2024 (e.g. KubeCon talks)?
|
||||
|
||||
<!--
|
||||
Examples include links to email, slides, or recordings.
|
||||
-->
|
||||
|
||||
4. KEP work in 2024 (v1.30, v1.31, v1.32):
|
||||
<!--
|
||||
TODO: Uncomment the following auto-generated list of KEPs, once reviewed & updated for correction.
|
||||
|
||||
Note: This list is generated from the KEP metadata in kubernetes/enhancements repository.
|
||||
If you find any discrepancy in the generated list here, please check the KEP metadata.
|
||||
Please raise an issue in kubernetes/community, if the KEP metadata is correct but the generated list is incorrect.
|
||||
-->
|
||||
|
||||
<!--
|
||||
|
||||
-->
|
||||
|
||||
## [Subprojects](https://git.k8s.io/community/sig-docs#subprojects)
|
||||
|
||||
|
||||
**Continuing:**
|
||||
- kubernetes-blog
|
||||
- localization
|
||||
- reference-docs
|
||||
- website
|
||||
|
||||
## [Working groups](https://git.k8s.io/community/sig-docs#working-groups)
|
||||
|
||||
|
||||
## Operational
|
||||
***3. Did you have community-wide updates in 2024 (e.g. KubeCon talks)?***
|
||||
* Document Your Career Path with SIG Docs! (Rey Lejano, Red Hat and Divya Mohan, SUSE): https://kccnceu2024.sched.com/event/1Yhj9/document-your-career-path-with-sig-docs-rey-lejano-red-hat-divya-mohan-suse
|
||||
* Navigating Cross-SIG Collaborations With SIG Docs (Savitha Raghunathan, Red Hat, Divya Mohan, SUSE, Xander Grzywinski, Independent, and Rey Lejano, Red Hat): https://kccncna2024.sched.com/event/1hox8/navigate-cross-sig-collaborations-with-sig-docs-rey-lejano-savitha-raghunathan-red-hat-divya-mohan-suse-xander-grzywinski-defense-unicorns
|
||||
|
||||
Operational tasks in [sig-governance.md]:
|
||||
- [ ] [README.md] reviewed for accuracy and updated if needed
|
||||
- [ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
|
||||
- [ ] Other contributing docs (e.g. in devel dir or contributor guide) reviewed for accuracy and updated if needed
|
||||
- [ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
|
||||
- [ ] SIG leaders (chairs, tech leads, and subproject leads) in [sigs.yaml] are accurate and active, and updated if needed
|
||||
- [ ] Meeting notes and recordings for 2024 are linked from [README.md] and updated/uploaded if needed
|
||||
|
||||
|
||||
[CONTRIBUTING.md]: https://git.k8s.io/community/sig-docs/CONTRIBUTING.md
|
||||
[sig-governance.md]: https://git.k8s.io/community/committee-steering/governance/sig-governance.md
|
||||
[README.md]: https://git.k8s.io/community/sig-docs/README.md
|
||||
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
|
||||
[devel]: https://git.k8s.io/community/contributors/devel/README.md
|
||||
- [x] [README.md] reviewed for accuracy and updated if needed
|
||||
- [x] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
|
||||
- [x] Other contributing docs (e.g. in devel dir or contributor guide) reviewed for accuracy and updated if needed
|
||||
- [x] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
|
||||
- [x] SIG leaders (chairs, tech leads, and subproject leads) in [sigs.yaml] are accurate and active, and updated if needed
|
||||
- [x] Meeting notes and recordings for 2024 are linked from [README.md] and updated/uploaded if needed
|
||||
Loading…
Reference in New Issue