Skip to content

Commit 8e2465b

Browse files
Merge pull request #434 from bergerhoffer/tweaks
A few minor tweaks to recent updates
2 parents 4fe765c + f30cf34 commit 8e2465b

File tree

3 files changed

+4
-3
lines changed
  • supplementary_style_guide/glossary_terms_conventions/general_conventions

3 files changed

+4
-3
lines changed

supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -406,11 +406,12 @@ There is no functional difference between the first server that was installed an
406406
==== image:images/yes.png[yes] ingress (noun, adjective)
407407
*Description*: In Red Hat OpenShift, _Ingress_ is a Kubernetes API object that developers can use to expose services within the cluster through an HTTP(S) load balancer and a proxy layer by using a public DNS entry. The `Ingress` resource defines the cluster-wide configuration for ingress traffic, and provides the ability to specify TLS options, a certificate, or a public CNAME that the OpenShift `IngressController` object can accept for HTTP(S) traffic. Additionally, _ingress_ can also be used to describe the incoming direction of network traffic. In Red Hat OpenShift, for example, this traffic is described as entering (ingress) or leaving (egress) an OpenShift cluster.
408408

409+
Always use `Ingress` with markup when referencing the `Ingress` resource or `IngressController` object in Red Hat OpenShift. Write in lowercase and omit markup when discussing _ingress_ as a traffic direction.
410+
409411
*Use it*: yes
410412

411413
[.vale-ignore]
412414
*Incorrect forms*:
413-
_Ingress_ without markup, when referencing the `Ingress` resource or the `IngressController` object. _Ingress_ with markup when used to describe the direction of traffic.
414415

415416
*See also*:
416417

supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
==== image:images/caution.png[caution] now (adverb)
211211
*Description*: In most content, you can use "now" when you mean the present time, immediately, or at once.
212212

213-
If your release notes are based on the templates in this guide's xref:release-notes[Release notes] section, use "with this update" rather than "now" to refer to the current release. This is because the temporal context of "now" can cause confusion in release notes that span multiple releases.
213+
If your release notes are based on the templates in this guide's xref:release-notes[Release notes] section, use "with this update" rather than "now" to refer to the current release. This is because the temporal context of "now" can cause confusion in release notes that span multiple releases.
214214

215215
*Use it*: with caution
216216

supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ Use "plugin" rather than "plug-in", unless you are updating existing content tha
416416
*See also*:
417417

418418
[[previously]]
419-
==== image:images/caution.png[caution] Previously (adverb)
419+
==== image:images/caution.png[caution] previously (adverb)
420420
*Description*: In most content, you can use "previously" to refer to something that was true or in effect at an earlier time but is no longer true or in effect now.
421421

422422
If your release notes are based on the templates in this guide's xref:release-notes[Release notes] section, use "before this update" rather than "previously" to refer to the current release. This is because the temporal context of "previously" can cause confusion in release notes that span multiple releases.

0 commit comments

Comments
 (0)