[WIP]: naming guidelines #8238
Open
[WIP]: naming guidelines #8238
+13
−0
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
k8s-ci-robot
added
do-not-merge/hold
k8s-ci-robot
added
the
size/S
|
LGTM |
pohly
reviewed
Jan 10, 2025
| @@ -0,0 +1,11 @@ | |||
| # Project Naming | |||
|
|
|||
| The Kubernetes project has historically named most of our components/projects with a "kube" substring like `kube-proxy`, `kubectl`, `kube-apiserver`, `kube-controller-manager`, `kube-scheduler`, `minikube`, ... | |||
|
|
||
| We recommend *but do not require* Kubernetes SIGS consider leveraging these when naming new subprojects, to further identify as an official project. | ||
|
|
||
| We ask that third-party projects refrain from confusing names that sound like an official Kubernetes subproject, IE "kube", "k8s", "kubernetes" substrings and pick some alternate creative name, with a notable exception for [Conformant Distros](https://www.cncf.io/training/certification/software-conformance/). Many existing projects have not done this, and we are not seeking to alter them, but do remember that "k8s" and "kubernetes" are protected trademarks. |
There was a problem hiding this comment.
Suggested change
| We ask that third-party projects refrain from confusing names that sound like an official Kubernetes subproject, IE "kube", "k8s", "kubernetes" substrings and pick some alternate creative name, with a notable exception for [Conformant Distros](https://www.cncf.io/training/certification/software-conformance/). Many existing projects have not done this, and we are not seeking to alter them, but do remember that "k8s" and "kubernetes" are protected trademarks. | |
| We ask that third-party projects refrain from using confusing names that sound like an official Kubernetes subproject, i.e. "kube", "k8s", "kubernetes" substrings and pick some alternate creative name, with a notable exception for [Conformant Distros](https://www.cncf.io/training/certification/software-conformance/). Many existing projects have not done this, and we are not seeking to alter them, but do remember that "k8s" and "kubernetes" are protected trademarks. |
soltysh
approved these changes
Jan 15, 2025
|
|
||
| "Kubernetes" and "K8s" are registered [trademarks under the Linux Foundation](https://www.linuxfoundation.org/legal/trademarks). | ||
|
|
||
| We recommend *but do not require* Kubernetes SIGS consider leveraging these when naming new subprojects, to further identify as an official project. |
There was a problem hiding this comment.
Suggested change
| We recommend *but do not require* Kubernetes SIGS consider leveraging these when naming new subprojects, to further identify as an official project. | |
| We recommend *but do not require* Kubernetes SIGs consider leveraging these when naming new subprojects, to further identify as an official project. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: BenTheElder, soltysh 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 |
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.
Which issue(s) this PR fixes:
Fixes https://lists.cncf.io/g/cncf-toc/message/8738
/hold