Adding initial directions for kubernetes organization owners #1569
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Kubernetes Github Organization Guide | ||
|
|
||
| The Kubernetes project leverages multiple GitHub organizations to store and | ||
| organize code. This guide contains the details on how to run those organizations | ||
| for CNCF compliance and for the guidelines of the community. | ||
|
|
||
| ## Organization Naming | ||
|
|
||
| Kubernetes managed organizations should be in the form of `kubernetes-[thing]`. | ||
| For example, [kubernetes-client](https://github.com/kubernetes-client) where the | ||
| API clients are housed. | ||
|
|
||
| Prior to creating an organization please contact the steering committee for | ||
| direction and approval. | ||
|
|
||
| Note: The CNCF, as part of the Linux Foundation, holds the trademark on the | ||
| Kubernetes name. All GitHub organizations with Kubernetes in the name should be | ||
| managed by the Kubernetes project or use a different name. | ||
|
|
||
| ## Transferring Outside Code Into A Kubernetes Organization | ||
|
|
||
| Due to licensing and CLA issues, prior to transferring software into a Kubernetes | ||
| managed organization there is some due diligence that needs to occur. Please | ||
| contact the steering committee and CNCF prior to moving any code in. | ||
|
|
||
| It is easier to start new code in a Kubernetes organization than it is to | ||
| transfer in existing code. | ||
|
|
||
| ## Current Organizations In Use | ||
|
|
||
| The following organizations are currently known to be part of the Kubernetes | ||
| project: | ||
|
There was a problem hiding this comment. The steering committee will be pushing out a doc soon regarding organizational structure which will likely cause the structure below to be reformed. There was a problem hiding this comment. Does that need to block this PR? Can we update the doc after those changes come out? There was a problem hiding this comment. I'd put a clause and change the content saying "this is all subject to change", but here is the current state, then lgtm from me. There was a problem hiding this comment. Added that clause |
||
|
|
||
| * [kubernetes](https://github.com/kubernetes) | ||
| * [kubernetes-client](https://github.com/kubernetes-client) | ||
| * [kubernetes-csi](https://github.com/kubernetes-csi) | ||
| * [kubernetes-graveyard](https://github.com/kubernetes-graveyard) † | ||
| * [kubernetes-helm](https://github.com/kubernetes-helm) | ||
| * [kubernetes-incubator](https://github.com/kubernetes-incubator) | ||
| * [kubernetes-retired](https://github.com/kubernetes-retired) | ||
| * [kubernetes-security](https://github.com/kubernetes-security) | ||
|
|
||
| † kubernetes-retired should be used instead of kubernetes-graveyard going forward. | ||
|
|
||
| Note, this list is subject to change. | ||
|
|
||
| There are more organization names that we are squatting on with possible future | ||
| intentions. [For more details please see community issue #1407](https://github.com/kubernetes/community/issues/1407). | ||
|
|
||
| ## Repository Guidance | ||
|
|
||
| Repositories have additional guidelines and requirements, such as the use of | ||
| CLA checking on all contributions. For more details on those please see the | ||
| [Kubernetes Template Project](https://github.com/kubernetes/kubernetes-template-project). | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^ is that something we can actually enforce? I'm not pushing back here, just curious.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@michelleN if the CNCF doesn't enforce the trademark on the name than it can loose the ability to do this. It's a general thing that you need to enforce usage on a name or you loose the right to. It's legal and as I'm not a lawyer I don't really know the details. I'm sure the Linux Foundation and CNCF folks know what to do, though.
Because the CNCF owns the name there are channels through GitHub to deal with this if it were to come to that (which it usually doesn't).