diff --git a/docs/help/contributor/style-guide/README.md b/docs/help/contributor/style-guide/README.md index 5f76b1852..840ca7596 100644 --- a/docs/help/contributor/style-guide/README.md +++ b/docs/help/contributor/style-guide/README.md @@ -15,3 +15,4 @@ Style Guides we adhere to, in priority order: (if one doesn't have the answer yo 1. [Page formatting standards](./style-and-formatting.md) 1. [Voice and language](./voice-and-language.md) 1. [Documenting Code](./documenting-code.md) +1. [Word and Phrase List](./word-and-phrase-list.md) diff --git a/docs/help/contributor/style-guide/word-and-phrase-list.md b/docs/help/contributor/style-guide/word-and-phrase-list.md new file mode 100644 index 000000000..d0b9b12a2 --- /dev/null +++ b/docs/help/contributor/style-guide/word-and-phrase-list.md @@ -0,0 +1,28 @@ +| Correct Term | Incorrect Term(s) | Notes | +|---------------------------------------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| autoTLS | auto TLS
Auto TLS
AutoTLS | | +| autoscaling | Auto-Scaling
auto-scaling
AutoScaling
Autoscaling | | +| Broker | broker | | +| 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 | | +| event | Event | | +| event source | Event Source | | +| Knative Eventing | eventing
Eventing Component | | +| Knative Service
Service | Knative service
service
ksvc
svc | | +| Knative Serving | serving
Serving Component | | +| standard input | stdin
STDIN | | +| standard output | stdout
STDOUT | | +| Trigger | trigger | | +| 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: "v2.7.0 and later patches". | | +| 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: "v2.7.0 and later patches". | | +| 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. | |