knative
/
docs
mirror of https://github.com/knative/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fixes #3746 (#3778)

This commit is contained in:
RichardJJG 2021-06-10 20:47:44 +01:00 committed by GitHub
parent 47ce045139
commit d8fc7905e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/help/contributor/style-guide/README.md
View File

@ -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)

28
docs/help/contributor/style-guide/word-and-phrase-list.md Normal file
View File

@ -0,0 +1,28 @@
| Correct Term | Incorrect Term(s) | Notes |
|---------------------------------------|------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| autoTLS | auto TLS<br>Auto TLS<br>AutoTLS | |
| autoscaling | Auto-Scaling<br>auto-scaling<br>AutoScaling<br>Autoscaling | |
| Broker | broker | |
| 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 | |
| event | Event | |
| event source | Event Source | |
| Knative Eventing | eventing<br>Eventing Component | |
| Knative Service<br>Service | Knative service<br>service<br>ksvc<br>svc | |
| Knative Serving | serving<br>Serving Component | |
| standard input | stdin<br>STDIN | |
| standard output | stdout<br>STDOUT | |
| Trigger | trigger | |
| 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: "v2.7.0 and later patches". | |
| 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: "v2.7.0 and later patches". | |
| 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. | |