Skip to content

Commit d78b3ee

Browse files
committed
feat: KIND Style Guide
Adding a style guide for contributors. The following text branding for the project is now official: - `kind` in backticks - "KIND" in all uppercase. Other prior forms, such as "KinD", are no longer allowed. Assisted-by: Cursor Signed-off-by: Adam Kaplan <adam@adambkaplan.com>
1 parent f20102c commit d78b3ee

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

site/content/docs/contributing/development.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,19 @@ inner markdown content. Usage: `{{</* securitygoose */>}} Notice markdown conten
140140

141141
1. `readFile` -- is used to inline file contents. Usage: `{{%/* readFile "static/examples/ingress/contour/patch.json" */%}}`
142142

143+
### Style Guide
144+
145+
KIND documentation is primarily maintained by code contributors and project maintainers, and as
146+
such does not strictly obey the [Kubernetes style guide]. However, we ask that
147+
documentation improvements adhere to [content best practices] and avoid [documentation anti-patterns].
148+
149+
Only use the following when referring to the project or command line:
150+
151+
- `kind` in all lowercase with backticks.
152+
- "KIND" in all uppercase.
153+
154+
Using "kind" without backticks, "Kind" with only one uppercase, or "KinD" with leading and trailing
155+
uppercase is not permitted.
143156

144157
## CI
145158

@@ -167,6 +180,9 @@ GitHub actions are configured in `.github/workflows` in the kind repo.
167180
[go-version]: https://sigs.k8s.io/kind/.go-version
168181
[quick start]: /docs/user/quick-start/
169182
[hugo]: https://gohugo.io
183+
[Kubernetes style guide]: https://kubernetes.io/docs/contribute/style/style-guide/
184+
[content best practices]: https://kubernetes.io/docs/contribute/style/style-guide/#content-best-practices
185+
[documentation anti-patterns]: https://kubernetes.io/docs/contribute/style/style-guide/#patterns-to-avoid
170186
[prow]: https://git.k8s.io/test-infra/
171187
[GitHub Actions]: https://github.com/features/actions
172188
[front matter]: https://gohugo.io/content-management/front-matter/

0 commit comments

Comments
 (0)