From 3812f603a8b7b8953ddf847bf2784683d096d2a2 Mon Sep 17 00:00:00 2001 From: Justin Garrison Date: Mon, 28 Mar 2022 10:56:30 -0700 Subject: [PATCH] Adding clarity for plugin repo naming I'm adding this based on convention I've seen with other plugins but if there's something else we recommend I'm fine with that too. This clarity can help plugin developers and companies looking for naming guidance and who want to avoid any trademark confusion. --- site/content/docs/developer-guide/develop/naming-guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/site/content/docs/developer-guide/develop/naming-guide.md b/site/content/docs/developer-guide/develop/naming-guide.md index 5a4862d8..2adb0d0e 100644 --- a/site/content/docs/developer-guide/develop/naming-guide.md +++ b/site/content/docs/developer-guide/develop/naming-guide.md @@ -67,6 +67,10 @@ Plugin names should not include "kube-" or "kubernetes-" prefixes. - **NO:** `kubectl kube-node-admin` ("kubectl " already has "kube" in it) - **YES:** `kubectl node-admin` + +While it is not recommended to include "kube*" in the plugin command name it +is recommended that the code repository starts with "kubectl-" so plugin +source code can be found outside of krew and the intended use is clear. ##### _Avoid Resource Acronyms and Abbreviations_