summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatt Farina <matt@mattfarina.com>2018-01-05 17:01:07 -0500
committerMatt Farina <matt@mattfarina.com>2018-01-18 20:37:51 -0500
commit8f29c509d04d8adf37d85dec7974cb5fc774329d (patch)
treef5f146633e2737b7f5cfc71bd6be3ba38843db8c
parent8ab61ca524e305ace6e01a7182c9683717b1b1ff (diff)
Adding initial directions for kubernetes organization owners
-rw-r--r--org-owners-guide.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/org-owners-guide.md b/org-owners-guide.md
new file mode 100644
index 00000000..3319cb70
--- /dev/null
+++ b/org-owners-guide.md
@@ -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). \ No newline at end of file