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

Avoid above and below (#4086) 

* Add rule to avoid using "above" and "below"

* Update rule
This commit is contained in:
Samia Nneji 2021-08-02 21:49:47 +01:00 committed by GitHub
parent 6578a6cb45
commit b6b5529936
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/help/contributor/style-guide/documenting-code.md
View File

@ -127,7 +127,7 @@ Apply code formatting only to special-purpose text:
- Creating or updating a resource: - Creating or updating a resource:
1. Create a YAML file using the template below: 1. Create a YAML file using the following template:
```yaml ```yaml
# YAML FILE CONTENTS # YAML FILE CONTENTS

4
docs/help/contributor/style-guide/word-and-phrase-list.md
View File

@ -13,14 +13,18 @@ For the correct spellings of words, see [Merriam-Webster](https://www.merriam-we
| ConfigMap | configmap<br>cm<br>config&nbsp;map<br>Config&nbsp;Map | | | ConfigMap | configmap<br>cm<br>config&nbsp;map<br>Config&nbsp;Map | |
| CloudEvent | cloud&nbsp;event<br>Cloud&nbsp;Event | | | CloudEvent | cloud&nbsp;event<br>Cloud&nbsp;Event | |
| Docker | docker | | | Docker | docker | |
| earlier | above | Don't use directional language to refer to a position in a document. |
| event | Event | | | event | Event | |
| event&nbsp;source | Event&nbsp;Source | | | event&nbsp;source | Event&nbsp;Source | |
| following | below | Don't use directional language to refer to a position in a document. |
| hostname | host&nbsp;name | | | hostname | host&nbsp;name | |
| Knative&nbsp;Eventing | eventing<br>Eventing&nbsp;Component | | | Knative&nbsp;Eventing | eventing<br>Eventing&nbsp;Component | |
| Knative&nbsp;Service<br>Service | Knative&nbsp;service<br>service<br>ksvc<br>svc | | | Knative&nbsp;Service<br>Service | Knative&nbsp;service<br>service<br>ksvc<br>svc | |
| Knative&nbsp;Serving | serving<br>Serving&nbsp;Component | | | Knative&nbsp;Serving | serving<br>Serving&nbsp;Component | |
| Kubernetes | kubernetes | | | 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". | | 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/ | | minikube | Minikube | https://minikube.sigs.k8s.io/docs/start/ |
| on-premises | on-prem<br>on-premise | | | on-premises | on-prem<br>on-premise | |
| SIG Docs | SIG-DOCS<br>Sig-docs<br>Sig-Docs<br>Sig&nbsp;Docs | | | SIG Docs | SIG-DOCS<br>Sig-docs<br>Sig-Docs<br>Sig&nbsp;Docs | |