Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A few minor tweaks to recent updates #434

Merged
merged 1 commit into from
Feb 2, 2024
Merged

A few minor tweaks to recent updates #434

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -406,11 +406,12 @@ There is no functional difference between the first server that was installed an
==== image:images/yes.png[yes] ingress (noun, adjective)
*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.

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.

*Use it*: yes

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

*See also*:

Expand Down
2 changes: 1 addition & 1 deletion supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@
==== image:images/caution.png[caution] now (adverb)
*Description*: In most content, you can use "now" when you mean the present time, immediately, or at once.

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.
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.

*Use it*: with caution

Expand Down
2 changes: 1 addition & 1 deletion supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -416,7 +416,7 @@ Use "plugin" rather than "plug-in", unless you are updating existing content tha
*See also*:

[[previously]]
==== image:images/caution.png[caution] Previously (adverb)
==== image:images/caution.png[caution] previously (adverb)
*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.

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.
Expand Down
Loading