deduping gov docs + creating a lifecycle checklist #3287
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
parispittman
added
sig/contributor-experience
k8s-ci-robot
added
size/L
parispittman
force-pushed
the
govdocs
branch
2 times, most recently
from
89c344d
to
f4a6999
Compare
|
cc @pwittrock |
ameukam
reviewed
Feb 21, 2019
| @@ -155,11 +168,15 @@ Issues impacting multiple subprojects in the SIG should be resolved by either: | |||
| - after 3 or more months it *SHOULD* be retired | |||
| - after 6 or more months it *MUST* be retired | |||
|
|
|||
| [SIG PM]: https://github.com/kubernetes/community/tree/master/sig-pm | |||
| [k/features]: https://github.com/kubernetes/features | |||
There was a problem hiding this comment.
Suggested change
| [k/features]: https://github.com/kubernetes/features | |
| [k/enhancements]: https://github.com/kubernetes/enhancements |
bgrant0607
reviewed
Feb 21, 2019
governance.md
Outdated
| @@ -97,10 +105,10 @@ field technical escalations, etc. | |||
| Example subprojects for a few SIGs: | |||
| * SIG Network: pod networking (CNI, etc.), Service (incl. kube-proxy), | |||
| Ingress, DNS, and Network policy | |||
| * SIG Apps: workload APIs, Helm, Kompose, ... | |||
| * SIG Apps: workload APIs, Kompose, ... | |||
There was a problem hiding this comment.
Please just remove SIG Apps as an example. The other examples are more clear
cblecker
reviewed
Feb 21, 2019
sig-governance.md
Outdated
| @@ -1,114 +1,3 @@ | |||
| # SIG Governance | |||
| This document should be deleted once all dependancies have been dealt with. This document was merged with several but most notably sunsetted in favor of the work in the [committee-steering] folder. | |||
There was a problem hiding this comment.
W0221 03:25:09.483] sig-governance.md:1:41: "dependancies" is a misspelling of "dependencies"
pwittrock
reviewed
Feb 27, 2019
| - Report activity in the weekly community meeting at least once every quarter | ||
| - Participate in release planning meetings and retrospectives, and burndown meetings, as needed | ||
| - Ensure related work happens in a project-owned github org and repository, with code and tests explicitly owned and supported by the SIG, including issue triage, PR reviews, test-failure response, bug fixes, etc. | ||
| - Use the [forums provided] as the primary means of working, communicating, and collaborating, as opposed to private emails and meetings |
There was a problem hiding this comment.
Should we add something about having a clearly defined group of deciders for sub projects?
pwittrock
reviewed
Feb 27, 2019
| @@ -91,6 +99,11 @@ Subproject Owner Role. (this different from a SIG or Organization Member). | |||
| - Contributing instructions defined in the SIG CONTRIBUTING.md | |||
|
|
|||
| ### Project Management | |||
| In addition, SIGs have the following responsibilities to SIG PM: | |||
There was a problem hiding this comment.
pwittrock
reviewed
Feb 27, 2019
| @@ -4,14 +4,14 @@ | |||
| Working Groups provide a formal avenue for disparate groups to collaborate around a common problem, craft a balanced | |||
| position, and disband. Because they represent the interests of multiple groups, they are a vehicle for consensus | |||
| building. If code is developed as part of collaboration within the Working Group, that code will be housed in an | |||
| appropriate repository as described in the [repositories document][repodoc]. The merging of this code into the repository | |||
There was a problem hiding this comment.
This breaks this link. Would you fix it to be the proper form?
pwittrock
reviewed
Feb 27, 2019
| will be governed by the standard policies regarding submitting code to that repository (e.g. developed within one or | ||
| more Subprojects owned by SIGs). | ||
|
|
||
| Because a working group is an official part of the Kubernetes project it is subject to steering committee oversight | ||
| over its formation and disbanding. | ||
|
|
||
| [repodoc]: https://github.com/kubernetes/community/blob/master/github-management/kubernetes-repositories.md | ||
| The tactical checklist to creation and/or retirement is found in the [SIG / WG lifeycle] document. |
pwittrock
reviewed
Feb 27, 2019
| and the steering committee with a link to the PR. A member of the community admin team will place a /hold on it | ||
| until it has an LGTM from at least one chair from each of the stakeholder SIGs, and a simple majority of the steering | ||
| committee. | ||
| Once the above questions have been answered, complete the rest of the checklist in the [SIG / WG lifeycle] document |
There was a problem hiding this comment.
Link for [SIG / WG lifeycle] doesn't work
pwittrock
reviewed
Feb 27, 2019
|
|
||
| [SIG / WG lifeycle] |
There was a problem hiding this comment.
Must add the target of the link here.
pwittrock
reviewed
Feb 27, 2019
governance.md
Outdated
| @@ -83,6 +87,10 @@ community. | |||
| See [sig governance] for more details about current SIG operating | |||
| mechanics, such as mailing lists, meeting times, etc. | |||
|
|
|||
| More information: | |||
| [SIG Governance Requirements] | |||
There was a problem hiding this comment.
These don't appear on separate lines which I think was the intent. Add bullets (e.g. *) or additional new-lines.
pwittrock
reviewed
Feb 27, 2019
sig-governance.md
Outdated
| @@ -1,114 +1,3 @@ | |||
| # SIG Governance | |||
| This document should be deleted once all dependancies have been dealt with. This document was merged with several but most notably sunsetted in favor of the work in the [committee-steering] folder. | |||
There was a problem hiding this comment.
This document was merged with several but most notably sunsetted in favor of the work
Awkward sentence.
pwittrock
reviewed
Feb 27, 2019
| Each one of these has a linked canonical source guideline from set up to moderation and your role and responsibilities for each. We are all responsible for enforcing our [code of conduct]. | ||
| - [ ] Read [moderation.md] and understand your role in keeping our community safe | ||
| - [ ] Create your mailing lists - One for your members and another for your chairs/leads | ||
| - Either [GoogleGroups] OR [discuss.kubernetes.io] |
There was a problem hiding this comment.
discuss.kubernetes.io link doesn't work
pwittrock
reviewed
Feb 27, 2019
sig-wg-lifecycle.md
Outdated
| - [ ] Subscribe to the kubernetes-sig-leads@googlegroups.com group | ||
| - [ ] Join the #chairs-and-techleads slack channel | ||
|
|
||
| ...with the community as part of [sig-governance] |
There was a problem hiding this comment.
sig-governance link doesn't work
pwittrock
reviewed
Feb 27, 2019
sig-wg-lifecycle.md
Outdated
|
|
||
| ## Prerequisites for a WG | ||
| - [ ] Read [wg-governance.md] | ||
| - [ ] Send email to [kubernetes-dev@googlegroups.com] with some of the questions answered from wg-goverance.md and wait for community discourse; ask for SIG sponsorship |
There was a problem hiding this comment.
I don't think the '[' are required. It renders them.
pwittrock
reviewed
Feb 27, 2019
sig-wg-lifecycle.md
Outdated
|
|
||
| ## Prerequisites for a WG | ||
| - [ ] Read [wg-governance.md] | ||
| - [ ] Send email to [kubernetes-dev@googlegroups.com] with some of the questions answered from wg-goverance.md and wait for community discourse; ask for SIG sponsorship |
There was a problem hiding this comment.
Should we have a template for this so they are easy to spot. e.g. the Subject is WG-Creation-Request: WG Foo
pwittrock
reviewed
Feb 27, 2019
sig-wg-lifecycle.md
Outdated
| - You’ll need: | ||
| - SIG Name | ||
| - Directory url | ||
| - mission statement |
There was a problem hiding this comment.
nit: inconsistent capitalization
k8s-ci-robot
added
the
needs-rebase
k8s-ci-robot
removed
the
needs-rebase
|
@pwittrock PTAL |
pwittrock
reviewed
Mar 6, 2019
|
|
||
| ## Prerequisites for a WG | ||
| - [ ] Read [wg-governance.md] | ||
| - [ ] Send email to [kubernetes-dev@googlegroups.com] titled "WG-Creation-Request: WG Foo" with some of the questions answered from wg-goverance.md and wait for community discourse; ask for SIG sponsorship |
There was a problem hiding this comment.
nit: should wg-governance.md be a link?
|
Overall this is a huge improvement. Thank you. /lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: parispittman, pwittrock The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thanks much. |
k8s-ci-robot
removed
the
do-not-merge/hold
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This addresses several related issues
(deduping, removing tactical/procedure from policy, formatting) that I won't completely tag here for purposes of not auto closing the issues. 1997, 2857
This needs many eyes. I tried to correct some content errors that I saw but please leave comments on stale processes, things that are duplicated still, etc.
TODO: