mirror of https://github.com/knative/docs.git
49 lines
10 KiB
Markdown
49 lines
10 KiB
Markdown
# Knative word and phrase list
|
|
|
|
For the correct spellings of words, see [Merriam-Webster](https://www.merriam-webster.com/).
|
|
|
|
| Correct Term | Incorrect Term(s) | Notes |
|
|
|-----------------------------------------|------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| autoTLS | auto TLS<br>Auto TLS<br>AutoTLS | |
|
|
| autoscaling | Auto-Scaling<br>auto-scaling<br>AutoScaling<br>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<br>command-line tool<br>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<br>cm<br>config map<br>Config Map | |
|
|
| CloudEvent | cloud event<br>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<br>Eventing Component | |
|
|
| Knative Service<br>Service | Knative service<br>service<br>ksvc<br>svc | |
|
|
| Knative Serving | serving<br>Serving Component | |
|
|
|\`knative/docs\` GitHub repository | Knative Docs repo<br>Docs repo | This is true for every Knative repo, such as Extensions, 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<br>on-premise | |
|
|
| rollout | roll-out |
|
|
| SIG Docs | SIG-DOCS<br>Sig-docs<br>Sig-Docs<br>Sig Docs | |
|
|
| standard input | stdin<br>STDIN | |
|
|
| standard output | stdout<br>STDOUT | |
|
|
| Trigger | trigger |
|
|
| time-based | time based |
|
|
| v | ver.<br>version<br>v. | Preface version numbers with "v". |
|
|
| v<version-number> and earlier | or/and lower<br>or/and below<br><=<br>v2.7 and later patches.<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version-number> or earlier | or/and lower<br>or/and below<br><=<br>v2.7 and later patches.<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version number> and earlier patches | or/and lower<br>or/and below<br><=<br>v2.7 and later patches.<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version number> or earlier patches | or/and lower<br>or/and below<br><=<br>v2.7 and later patches.<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version-number> and later | or/and higher<br>or/and greater<br>or/and above<br>>=<br>"v2.7 and later patches".<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version-number> or later | or/and higher<br>or/and greater<br>or/and above<br>>=<br>"v2.7 and later patches".<br>Where patches are mentioned, use three digits: "v2.7.0 and later patches".| |
|
|
| v<version-number> and later patches| or/and higher<br>or/and greater<br>or/and above<br>>=<br>"v2.7 and later patches".<br>Where patches are mentioned, use three digits.| |
|
|
| v<version-number> or later patches | or/and higher<br>or/and greater<br>or/and above<br>>=<br>"v2.7 and later patches".<br>Where patches are mentioned, use three digits.| |
|
|
| v1.6 | v1.6.X<br>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. |
|