From c1906db21fe840623c8201cc7a245068b00bf901 Mon Sep 17 00:00:00 2001 From: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> Date: Tue, 26 Jan 2021 07:46:27 -0800 Subject: [PATCH] Update documentation-style-guide.md (#30611) * Update documentation-style-guide.md * Update contribute/style-guides/documentation-style-guide.md Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> Co-authored-by: Ursula Kallio <73951760+osg-grafana@users.noreply.github.com> --- contribute/style-guides/documentation-style-guide.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/contribute/style-guides/documentation-style-guide.md b/contribute/style-guides/documentation-style-guide.md index f95971757f9..115856cef3c 100644 --- a/contribute/style-guides/documentation-style-guide.md +++ b/contribute/style-guides/documentation-style-guide.md @@ -147,6 +147,18 @@ The first letter of the name of an integration is always capitalized, even if th - Etcd Integration - I installed an integration on my local Grafana. +#### Kubernetes objects + +Capitalize Kubernetes objects such as Job, Pod, and StatefulSet when it is clear you are specifically talking about them and not generic jobs, pods, or whatever. + +Introduce the object as "Kubernetes XX" on the first usage, then just the object in subsequent uses. + +**Example:** + +Create the Kubernetes Job and check the logs to retrieve the generated token: + +The Job requires the token be submitted as … + ### Links and references When referencing another document, use "Refer to" rather than alternatives such as "See" or "Check out."