From b6b5529936adf266890b855923b17da3b7634f31 Mon Sep 17 00:00:00 2001 From: Samia Nneji Date: Mon, 2 Aug 2021 21:49:47 +0100 Subject: [PATCH] Avoid above and below (#4086) * Add rule to avoid using "above" and "below" * Update rule --- docs/help/contributor/style-guide/documenting-code.md | 2 +- docs/help/contributor/style-guide/word-and-phrase-list.md | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/help/contributor/style-guide/documenting-code.md b/docs/help/contributor/style-guide/documenting-code.md index f5d46365b..1e315d39b 100644 --- a/docs/help/contributor/style-guide/documenting-code.md +++ b/docs/help/contributor/style-guide/documenting-code.md @@ -127,7 +127,7 @@ Apply code formatting only to special-purpose text: - 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 FILE CONTENTS diff --git a/docs/help/contributor/style-guide/word-and-phrase-list.md b/docs/help/contributor/style-guide/word-and-phrase-list.md index ed4c42f53..3a79ffde0 100644 --- a/docs/help/contributor/style-guide/word-and-phrase-list.md +++ b/docs/help/contributor/style-guide/word-and-phrase-list.md @@ -13,14 +13,18 @@ For the correct spellings of words, see [Merriam-Webster](https://www.merriam-we | 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 | | | 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 | | | SIG Docs | SIG-DOCS
Sig-docs
Sig-Docs
Sig Docs | |