Pod在k8s中为什么必须将其首字母大写?

huangapple go评论59阅读模式
英文:

Why Pod must have its first letter capitalized in k8s?

问题

我在k8s操作员存储库中看到,“Pod” 一词始终以大写字母 P 拼写。例如,像“此函数创建一个 Pod”这样的注释,而不是“此函数创建一个 pod”。请注意“Pod”中的大写字母。为什么人们要强制将“Pod”拼写为“Pod”呢?

英文:

I saw in k8s operators repo that a Pod is always spelled with P capitalized.
For example, a comment like This function creates a Pod, instead of This function creates a pod. Note the capitalization in Pod.

Why do people enforce the spelling of Pod as Pod?

答案1

得分: 2

以下是已经翻译好的部分:

虽然这可能不是最好的答案,但在这个问题上,以下是我的两分钱的价值。

我认为大写 P(od),S(ervice)或D(eployment)会增加清晰度,并避免混淆,以确保它不是在K8s资源的上下文中引用。对于具有多重含义的单词来说,它增加了清晰度,比如"service"(有人可能指的是微服务,谁知道呢¯_(ツ)_/¯)和"deployment"显然有其他含义。

我曾经在其中一些讨论中遇到过这种情况,其中之一在这里:
https://github.com/kubernetes/website/issues/20862

此外,一些广泛使用的文档风格指南模式如下:
https://kubernetes.io/docs/contribute/style/style-guide/

https://developers.google.com/style/capitalization

有助于建立约定和指南,有助于确保系统内的一致性、清晰度和标准化,尤其是在技术社区,人们可能在多个团队/领域/项目中工作。

我确信我或其他人可以进一步阐述这一点,只要有时间,但我希望这给你一些思考背后的想法,更重要的是,它是有道理的 Pod在k8s中为什么必须将其首字母大写?

英文:

While this may not be the best answer but still, here are my two pennies worth on the matter.

I think capitalizing P(od), an S(ervice) or a D(eployment) gives clarity and avoids the confusion that it is being referred to in the context of a K8s resource. It adds clarity for words with multiple meanings, "service" (one might be referring to a microservice, who knows ¯_(ツ)_/¯) and "deployment" obviously have other meanings.

I have come across a few such discussions with one of them here:
https://github.com/kubernetes/website/issues/20862

Also, some widely used documentation style guides patterns like:
https://kubernetes.io/docs/contribute/style/style-guide/

https://developers.google.com/style/capitalization

help set conventions & guidelines which help to ensure consistency, clarity & standardization across the sytem, especially within the technical community where people could be working on multiple teams/domains/projects etc.

I'm sure I or someone could elaborate this as much as one has time to spare but I hope it gives you some idea behind the thought process and more importantly it makes sense Pod在k8s中为什么必须将其首字母大写?

huangapple
  • 本文由 发表于 2023年4月11日 06:58:18
  • 转载请务必保留本文链接:https://go.coder-hub.com/75981318.html
匿名

发表评论

匿名网友

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen:

确定