docs/contribute-to-docs/style-guide/word-and-phrase-list.md

Knative word and phrase list

For the correct spellings of words, see Merriam-Webster.

Correct Term	Incorrect Term(s)	Notes
autoTLS	auto TLS Auto TLS AutoTLS
autoscaling	Auto-Scaling auto-scaling AutoScaling Autoscaling
because	since	"Since" is ambiguous; it can refer to the passage of time. "Because" refers to causation or the reason for something.
Broker	broker
can	may	Use "can" to convey permission, to refer to an optional action, or to refer to a possible outcome.
Channel	channel
CLI	command-line command-line tool command line	Use CLI instead of command line interface. Command line is slightly different and for this context should not be used.
component	Component
ConfigMap	configmap cm config map Config Map
CloudEvent	cloud event Cloud Event
Docker	docker
earlier	above	Don't use directional language to refer to a position in a document.
event	Event
event source	Event Source
following	below	Don't use directional language to refer to a position in a document.
hostname	host name
Knative Eventing	eventing Eventing Component
Knative Service Service	Knative service service ksvc svc
Knative Serving	serving Serving Component
`knative/docs` GitHub repository	Knative Docs repo Docs repo	This is true for every Knative repo, such as Sandbox, etc.
Kubernetes	kubernetes
later	below	Don't use directional language to refer to a position in a document.
might	may	Reserve "may" for official policy or legal considerations. To convey possibility, use "can" or "might". To convey permission, use "can".
minikube	Minikube	https://minikube.sigs.k8s.io/docs/start/
on-premises	on-prem on-premise
rollout	roll-out
SIG Docs	SIG-DOCS Sig-docs Sig-Docs Sig Docs
standard input	stdin STDIN
standard output	stdout STDOUT
Trigger	trigger
time-based	time based
v	ver. version v.	Preface version numbers with "v".
v and earlier	or/and lower or/and below <= v2.7 and later patches. Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v or earlier	or/and lower or/and below <= v2.7 and later patches. Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v and earlier patches	or/and lower or/and below <= v2.7 and later patches. Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v or earlier patches	or/and lower or/and below <= v2.7 and later patches. Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v and later	or/and higher or/and greater or/and above >= "v2.7 and later patches". Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v or later	or/and higher or/and greater or/and above >= "v2.7 and later patches". Where patches are mentioned, use three digits: "v2.7.0 and later patches".
v and later patches	or/and higher or/and greater or/and above >= "v2.7 and later patches". Where patches are mentioned, use three digits.
v or later patches	or/and higher or/and greater or/and above >= "v2.7 and later patches". Where patches are mentioned, use three digits.
v1.6	v1.6.X v1.6.x	It's likely better to omit the wildcard, leaving the unspecified major, minor, or patch as implied.
	should	Avoid "should"; it is ambiguous; "should" implies that the action is recommended but optional; if the document writer intends to mandate an action, "should" is not an appropriate choice.