search

kubernetes / community

Kubernetes community content
Apache License 2.0
11.92k stars 5.16k forks source link

sig name consistency #703

Closed spiffxp closed 5 years ago

spiffxp commented 7 years ago

There are a number of places where sig names are ever-so-slightly inconsistent. I'd like us to link back to this issue when we identify those areas. Update docs, preferably adjust what we can.

For a sig foo, I expect:

Examples of where we've hit inconsistencies:

EDIT: Is it reasonable to expect the same for working groups as well?

spiffxp commented 7 years ago

FYI @kubernetes/sig-contributor-experience-misc

spiffxp commented 7 years ago

FYI @xiangpengzhao

xiangpengzhao commented 7 years ago

+1000

It would be good to also have our sig meeting channels follow the name consistency.

In the page SIGs and Working Groups, we use hangouts or zoom to hold meetings. And some meeting channels use number as id and others use name string.

@spiffxp

spiffxp commented 6 years ago

ping @castrojo since we were talking about this the other day

idvoretskyi commented 6 years ago

big +1

castrojo commented 6 years ago

So what I was thinking was proposing something to the SIG governance document that reads something like "The entry dir: sig-api-machinery in sigs.yaml becomes the machine-consumable naming convention that all your other resources inherit."

Then we make sure the slack channels, etc. align up. Renaming the slack channels is easy, we just renamed #sig-scale without problems. Not sure on how disruptive renaming google groups. I think the annoying bit will be the Zoom channels and calendars, which seems to be a mixture of numbers and shortcuts.

However I think we can make the argument to all the leads that being able to just guess the channel name based on convention will be very useful for people, for example I would be able to guess that zoom.us/j/sig-ui is the right room. Calendars will be annoying but making SIGs follow this convention will lead to improved tooling and consistency.

cblecker commented 6 years ago

we can change/update sigs.yaml as needed.. there's actually three lines in there (dir, name, label) that are all similar. Having one as the source of truth, and then changing around the generator as needed would work

bgrant0607 commented 6 years ago

Zoom channels should be prefixed with "k8s-"

Other open-source communities are adopting SIGs

spiffxp commented 6 years ago

re: zoom-channels, you only get one vanity url aka "Personal Link" via https://zoom.us/profile

Personal Link is an alias of your personal meeting URL https://zoom.us/j/REDACTED. It must be 5 to 40 characters. It must start with a letter and can contain only letters (a-z), numbers (0-9) and periods (".")

Couldn't use a dash, so now I've got https://zoom.us/my/k8s.sig.testing, WDYT?

Only other URL I've seen is https://zoom.us/my/kubernetescommunity

idvoretskyi commented 6 years ago

Dots look weird, IMO.

On Oct 24, 2017 11:38 PM, "Aaron Crickenberger" notifications@github.com wrote:

re: zoom-channels, you only get one vanity url aka "Personal Link" via https://zoom.us/profile

Personal Link is an alias of your personal meeting URL https://zoom.us/j/REDACTED. It must be 5 to 40 characters. It must start with a letter and can contain only letters (a-z), numbers (0-9) and periods (".")

Couldn't use a dash, so now I've got https://zoom.us/my/k8s.sig.testing, WDYT?

Only other URL I've seen is https://zoom.us/my/kubernetescommunity

— You are receiving this because you are on a team that was mentioned. Reply to this email directly, view it on GitHub https://github.com/kubernetes/community/issues/703#issuecomment-339140580, or mute the thread https://github.com/notifications/unsubscribe-auth/AAHOu5TiQRl-EYCOlPdPCnSRmvH4E2jIks5svljRgaJpZM4N1w4T .

bgrant0607 commented 6 years ago

dots are better than no punctuation.

An existing example: https://zoom.us/my/sig.apps

k8s.sig.testing seems fine.

spiffxp commented 6 years ago

Fun (annoying) facts discovered while trying to reconcile for sig-contributor-experience

So we're back to kuberenetes-wg-contribex and #sig-contribex for now

fejta-bot commented 6 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

cblecker commented 6 years ago

/remove-lifecycle stale

fejta-bot commented 6 years ago

Issues go stale after 90d of inactivity. Mark the issue as fresh with /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle stale

fejta-bot commented 6 years ago

Stale issues rot after 30d of inactivity. Mark the issue as fresh with /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta. /lifecycle rotten /remove-lifecycle stale

cblecker commented 6 years ago

/remove-lifecycle rotten

spiffxp commented 6 years ago

/lifecycle frozen As a "known issue".

I'm not sure I ever foresee this getting fixed if the definition of done is "make everything the same". I think instead a successful answer to these questions would do it:

parispittman commented 5 years ago

sig-wg-lifecycle.md should cover most of these conventions along with the other governance doc updates recently. most of the naming convention information is included in each relevant section. do you think this is good @spiffxp?

contribex ml has also been changed to kubernetes-sig-contribex@

spiffxp commented 5 years ago

/close Yes, I think between sigs.yaml evolving to hold much of this contact info, and the lifecycle doc spelling out how to implement most of the conventions, we're good here

k8s-ci-robot commented 5 years ago

@spiffxp: Closing this issue.

In response to [this](https://github.com/kubernetes/community/issues/703#issuecomment-475067846): >/close >Yes, I think between sigs.yaml evolving to hold much of this contact info, and the lifecycle doc spelling out how to implement most of the conventions, we're good here Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.