Update annual reports documentation to point to actual templates used for generating reports
Signed-off-by: Maciej Szulik <soltysh@gmail.com>
This commit is contained in:
Maciej Szulik
parent
77e266763b
commit
23b1bbf63e
|
|
@ -64,220 +64,16 @@ of being more explicit than using our upstream shorthand or abbreviations.
|
||||||
collaborate with your community: gdocs, hackmd, etc - it will all land back into
|
collaborate with your community: gdocs, hackmd, etc - it will all land back into
|
||||||
a pull request at the end.
|
a pull request at the end.
|
||||||
|
|
||||||
## Questions for report:
|
## Questions for report
|
||||||
|
|
||||||
### Special Interest Groups:
|
### Special Interest Groups
|
||||||
|
|
||||||
```
|
The questions are available as a [go-template](https://pkg.go.dev/text/template) file [here](../../generator/annual-report/sig_report.tmpl).
|
||||||
# $sig-name - $YYYY annual report
|
|
||||||
|
|
||||||
## Current initiatives
|
|
||||||
|
|
||||||
1. What work did the SIG do this year that should be highlighted?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
2. What initiatives are you working on that aren't being tracked in KEPs?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
3. KEP work in $YYYY (1.x, 1.y, 1.z):
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Generated from kubernetes/enhancements kep.yaml files
|
|
||||||
1. with SIG as owning-sig or in participating-sigs
|
|
||||||
2. listing 1.x, 1.y, or 1.z in milestones or in latest-milestone
|
|
||||||
-->
|
|
||||||
|
|
||||||
- Stable
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.stable
|
|
||||||
- Beta
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.beta
|
|
||||||
- Alpha
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md) - $milestone.alpha
|
|
||||||
- Pre-alpha
|
|
||||||
- [$kep-number - $title](https://git.k8s.io/community/$link/README.md)
|
|
||||||
|
|
||||||
## Project health
|
|
||||||
|
|
||||||
1. What areas and/or subprojects does your group need the most help with?
|
|
||||||
Any areas with 2 or fewer OWNERs? (link to more details)
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
2. What metrics/community health stats does your group care about and/or measure?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
3. Does your [CONTRIBUTING.md] help **new** contributors engage with your group specifically by pointing
|
|
||||||
to activities or programs that provide useful context or allow easy participation?
|
|
||||||
|
|
||||||
-
|
|
||||||
|
|
||||||
4. If your group has special training, requirements for reviewers/approvers, or processes beyond the general [contributor guide],
|
|
||||||
does your [CONTRIBUTING.md] document those to help **existing** contributors grow throughout the [contributor ladder]?
|
|
||||||
|
|
||||||
-
|
|
||||||
|
|
||||||
5. Does the group have contributors from multiple companies/affiliations?
|
|
||||||
|
|
||||||
-
|
|
||||||
|
|
||||||
6. Are there ways end users/companies can contribute that they currently are not?
|
|
||||||
If one of those ways is more full time support, what would they work on and why?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
## Membership
|
|
||||||
|
|
||||||
- Primary slack channel member count:
|
|
||||||
- Primary mailing list member count:
|
|
||||||
- Primary meeting attendee count (estimated, if needed):
|
|
||||||
- Primary meeting participant count (estimated, if needed):
|
|
||||||
- Unique reviewers for SIG-owned packages: {generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files}
|
|
||||||
- Unique approvers for SIG-owned packages: {generated from OWNERS files referenced from subprojects, expanded with OWNERS_ALIASES files}
|
|
||||||
|
|
||||||
Include any other ways you measure group membership
|
|
||||||
|
|
||||||
## Subprojects
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
|
|
||||||
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
|
|
||||||
-->
|
|
||||||
|
|
||||||
New in $YYYY:
|
|
||||||
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
|
|
||||||
-
|
|
||||||
|
|
||||||
Retired in $YYYY:
|
|
||||||
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
|
|
||||||
-
|
|
||||||
|
|
||||||
Continuing:
|
|
||||||
- [$subproject-name](https://git.k8s.io/community/$sig-id#$subproject-name)
|
|
||||||
-
|
|
||||||
|
|
||||||
## Working groups
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Generated from delta of sigs.yaml from $YYYY-01-01 to $YYYY-12-31
|
|
||||||
Manually visible via `git diff HEAD@{$YYYY-01-01} HEAD@{$YYYY-12-31} -- $sig-id/README.md`
|
|
||||||
-->
|
|
||||||
|
|
||||||
New in $YYYY:
|
|
||||||
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
|
|
||||||
-
|
|
||||||
|
|
||||||
Retired in $YYYY:
|
|
||||||
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
|
|
||||||
-
|
|
||||||
|
|
||||||
Continuing:
|
|
||||||
- [$wg-name](https://git.k8s.io/community/$wg-id/) ([$YYYY report](https://git.k8s.io/community/$wg-id/annual-report-$YYYY.md))
|
|
||||||
-
|
|
||||||
|
|
||||||
## Operational
|
|
||||||
|
|
||||||
Operational tasks in [sig-governance.md]:
|
|
||||||
|
|
||||||
[ ] [README.md] reviewed for accuracy and updated if needed
|
|
||||||
[ ] [CONTRIBUTING.md] reviewed for accuracy and updated if needed
|
|
||||||
(or created if missing and your contributor steps and experience are different or more
|
|
||||||
in-depth than the documentation listed in the general [contributor guide] and [devel] folder.)
|
|
||||||
[ ] Subprojects list and linked OWNERS files in [sigs.yaml] reviewed for accuracy and updated if needed
|
|
||||||
[ ] SIG leaders (chairs, tech leads, and subproject owners) in [sigs.yaml] are accurate and active, and updated if needed
|
|
||||||
[ ] Meeting notes and recordings for $YYYY are linked from [README.md] and updated/uploaded if needed
|
|
||||||
[ ] Did you have community-wide updates in $YYYY (e.g. kubecon, or kubernetes-dev@ emails)? Links to email, slides, or recordings:
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
[CONTRIBUTING.md]: https://git.k8s.io/community/$sig-id/CONTRIBUTING.md
|
|
||||||
[contributor ladder]: https://git.k8s.io/community/community-membership.md
|
|
||||||
[sig-governance.md]: https://git.k8s.io/community/committee-steering/governance/sig-governance.md
|
|
||||||
[README.md]: https://git.k8s.io/community/$sig-id/README.md
|
|
||||||
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
|
|
||||||
[contributor guide]: https://git.k8s.io/community/contributors/guide/README.md
|
|
||||||
[devel]: https://git.k8s.io/community/contributors/devel/README.md
|
|
||||||
```
|
|
||||||
|
|
||||||
### Working Groups:
|
### Working Groups:
|
||||||
|
|
||||||
```
|
The questions are available as a [go-template](https://pkg.go.dev/text/template) file [here](../../generator/annual-report/wg_report.tmpl).
|
||||||
# $wg-name - $YYYY annual report
|
|
||||||
|
|
||||||
## Current initiatives
|
|
||||||
|
|
||||||
1. What work did the WG do this year that should be highlighted?
|
|
||||||
For example, artifacts, reports, white papers produced this year.
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
2. What initiatives are you working on that aren't being tracked in KEPs?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
## Project health
|
|
||||||
|
|
||||||
1. What’s the current roadmap until completion of the working group?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
2. Does the group have contributors from multiple companies/affiliations?
|
|
||||||
|
|
||||||
-
|
|
||||||
|
|
||||||
3. Are there ways end users/companies can contribute that they currently are not?
|
|
||||||
If one of those ways is more full time support, what would they work on and why?
|
|
||||||
|
|
||||||
-
|
|
||||||
-
|
|
||||||
|
|
||||||
## Membership
|
|
||||||
|
|
||||||
- Primary slack channel member count:
|
|
||||||
- Primary mailing list member count:
|
|
||||||
- Primary meeting attendee count (estimated, if needed):
|
|
||||||
- Primary meeting participant count (estimated, if needed):
|
|
||||||
|
|
||||||
Include any other ways you measure group membership
|
|
||||||
|
|
||||||
## Operational
|
|
||||||
|
|
||||||
Operational tasks in [wg-governance.md]:
|
|
||||||
|
|
||||||
[ ] [README.md] reviewed for accuracy and updated if needed
|
|
||||||
[ ] WG leaders in [sigs.yaml] are accurate and active, and updated if needed
|
|
||||||
[ ] Meeting notes and recordings for $YYYY are linked from [README.md] and updated/uploaded if needed
|
|
||||||
[ ] Updates provided to sponsoring SIGs in $YYYY
|
|
||||||
- [$sig-name](https://git.k8s.io/community/$sig-id/)
|
|
||||||
- links to email, meeting notes, slides, or recordings, etc
|
|
||||||
- [$sig-name](https://git.k8s.io/community/$sig-id/)
|
|
||||||
- links to email, meeting notes, slides, or recordings, etc
|
|
||||||
-
|
|
||||||
|
|
||||||
[wg-governance.md]: https://git.k8s.io/community/committee-steering/governance/wg-governance.md
|
|
||||||
[README.md]: https://git.k8s.io/community/$wg-id/README.md
|
|
||||||
[sigs.yaml]: https://git.k8s.io/community/sigs.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
### Thanks
|
### Thanks
|
||||||
Thanks to the Apache Software Foundation for their open guidance on PMC
|
Thanks to the Apache Software Foundation for their open guidance on PMC
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue