Adding initial directions for kubernetes organization owners

This commit is contained in:
Matt Farina 2018-01-05 17:01:07 -05:00
parent 8ab61ca524
commit 8f29c509d0
No known key found for this signature in database
GPG Key ID: 9436E80BFBA46909
1 changed files with 54 additions and 0 deletions

54
org-owners-guide.md Normal file
View File

@ -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:
* [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).