Skip to content

Commit fe1c2df

Browse files
committed
OSDOCS-10115: Substituted 60+ contractions over 40+ files..
1 parent 4723ee3 commit fe1c2df

File tree

48 files changed

+78
-78
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+78
-78
lines changed

modules/builds-using-build-volumes.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ endif::[]
99
[id="builds-using-build-volumes_{context}"]
1010
= Using build volumes
1111

12-
You can mount build volumes to give running builds access to information that you don't want to persist in the output container image.
12+
You can mount build volumes to give running builds access to information that you do not want to persist in the output container image.
1313

1414
Build volumes provide sensitive information, such as repository credentials, that the build environment or configuration only needs at build time. Build volumes are different from xref:../../cicd/builds/creating-build-inputs.adoc#builds-define-build-inputs_creating-build-inputs[build inputs], whose data can persist in the output container image.
1515

@@ -55,7 +55,7 @@ spec:
5555
attribute: value
5656
----
5757
<1> Required. A unique name.
58-
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and doesn't collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
58+
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and does not collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
5959
<3> Required. The type of source, `ConfigMap`, `Secret`, or `CSI`.
6060
<4> Required. The name of the source.
6161
<5> Required. The driver that provides the ephemeral CSI volume.
@@ -105,7 +105,7 @@ spec:
105105
----
106106
107107
<1> Required. A unique name.
108-
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and doesn't collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
108+
<2> Required. The absolute path of the mount point. It must not contain `..` or `:` and does not collide with the destination path generated by the builder. The `/opt/app-root/src` is the default home directory for many Red Hat S2I-enabled images.
109109
<3> Required. The type of source, `ConfigMap`, `Secret`, or `CSI`.
110110
<4> Required. The name of the source.
111111
<5> Required. The driver that provides the ephemeral CSI volume.

modules/cluster-cloud-controller-config-osp.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ This option is unsupported if you use {rh-openstack} earlier than version 17 wit
191191
// | The id of the loadbalancer flavor to use. Uses octavia default if not set.
192192

193193
// | `availability-zone`
194-
// | The name of the loadbalancer availability zone to use. The Octavia availability zone capabilities will not be used if it is not set. The parameter will be ignored if the Octavia version doesn't support availability zones yet.
194+
// | The name of the loadbalancer availability zone to use. The Octavia availability zone capabilities will not be used if it is not set. The parameter will be ignored if the Octavia version does not support availability zones yet.
195195

196196
| `LoadBalancerClass "ClassName"`
197197
a| This is a config section that comprises a set of options:

modules/cluster-logging-elasticsearch-rules.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can view these alerting rules in the {product-title} web console.
1717

1818
|`ElasticsearchClusterNotHealthy`
1919
|The cluster health status has been RED for at least 2 minutes. The cluster does not accept writes, shards may be missing, or the master
20-
node hasn't been elected yet.
20+
node has not been elected yet.
2121
|Critical
2222

2323
|`ElasticsearchClusterNotHealthy`

modules/cluster-logging-exported-fields-top-level-fields.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The following values come from link:http://sourceware.org/git/?p=glibc.git;a=blo
7979
The two following values are not part of `syslog.h` but are widely used:
8080

8181
* `8` = `trace`, trace-level messages, which are more verbose than `debug` messages.
82-
* `9` = `unknown`, when the logging system gets a value it doesn't recognize.
82+
* `9` = `unknown`, when the logging system gets a value it does not recognize.
8383

8484
Map the log levels or priorities of other logging systems to their nearest match in the preceding list. For example, from link:https://docs.python.org/2.7/library/logging.html#logging-levels[python logging], you can match `CRITICAL` with `crit`, `ERROR` with `err`, and so on.
8585

modules/cnf-configure_for_irq_dynamic_load_balancing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Starting pod/<node-name>-debug ...
118118
To use host binaries, run `chroot /host`
119119
120120
Pod IP: <ip-address>
121-
If you don't see a command prompt, try pressing enter.
121+
If you do not see a command prompt, try pressing enter.
122122
123123
sh-4.4#
124124
----

modules/creating-your-first-content.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Topics:
9696
----
9797

9898
. On the command line, run `asciibinder` from the root folder of openshift-docs.
99-
You don't have to add or commit your changes for asciibinder to run.
99+
You do not have to add or commit your changes for asciibinder to run.
100100

101101
. After the asciibinder build completes, open up your browser and navigate to
102102
<YOUR-LOCAL-GIT-REPO-LOCATION>/openshift-docs/_preview/openshift-enterprise/my_first_mod_docs/my_guide/assembly_my-first-assembly.html
@@ -105,4 +105,4 @@ You don't have to add or commit your changes for asciibinder to run.
105105
contents from your module `My First Module`.
106106

107107
NOTE: You can delete this branch now if you are done testing. This branch
108-
shouldn't be submitted to the upstream openshift-docs repository.
108+
should not be submitted to the upstream openshift-docs repository.

modules/dynamic-plugin-api.adoc

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ Component for displaying an error status popover.
122122
|Parameter Name |Description
123123
|`title` |(optional) status text
124124
|`iconOnly` |(optional) if true, only displays icon
125-
|`noTooltip` |(optional) if true, tooltip won't be displayed
125+
|`noTooltip` |(optional) if true, tooltip is not displayed
126126
|`className` |(optional) additional class name for the component
127127
|`popoverTitle` |(optional) title for popover
128128
|===
@@ -143,7 +143,7 @@ Component for displaying an information status popover.
143143
|Parameter Name |Description
144144
|`title` |(optional) status text
145145
|`iconOnly` |(optional) if true, only displays icon
146-
|`noTooltip` |(optional) if true, tooltip won't be displayed
146+
|`noTooltip` |(optional) if true, tooltip is not displayed
147147
|`className` |(optional) additional class name for the component
148148
|`popoverTitle` |(optional) title for popover
149149
|===
@@ -164,7 +164,7 @@ Component for displaying a progressing status popover.
164164
|Parameter Name |Description
165165
|`title` |(optional) status text
166166
|`iconOnly` |(optional) if true, only displays icon
167-
|`noTooltip` |(optional) if true, tooltip won't be displayed
167+
|`noTooltip` |(optional) if true, tooltip is not displayed
168168
|`className` |(optional) additional class name for the component
169169
|`popoverTitle` |(optional) title for popover
170170
|===
@@ -185,7 +185,7 @@ Component for displaying a success status popover.
185185
|Parameter Name |Description
186186
|`title` |(optional) status text
187187
|`iconOnly` |(optional) if true, only displays icon
188-
|`noTooltip` |(optional) if true, tooltip won't be displayed
188+
|`noTooltip` |(optional) if true, tooltip is not displayed
189189
|`className` |(optional) additional class name for the component
190190
|`popoverTitle` |(optional) title for popover
191191
|===
@@ -219,7 +219,7 @@ Hook that provides information about user access to a given resource. It returns
219219

220220
React hook for consuming Console extensions with resolved `CodeRef` properties. This hook accepts the same argument(s) as `useExtensions` hook and returns an adapted list of extension instances, resolving all code references within each extension's properties.
221221

222-
Initially, the hook returns an empty array. After the resolution is complete, the React component is re-rendered with the hook returning an adapted list of extensions. When the list of matching extensions changes, the resolution is restarted. The hook will continue to return the previous result until the resolution completes.
222+
Initially, the hook returns an empty array. After the resolution is complete, the React component is re-rendered with the hook returning an adapted list of extensions. When the list of matching extensions changes, the resolution is restarted. The hook continues to return the previous result until the resolution completes.
223223

224224
The hook's result elements are guaranteed to be referentially stable across re-renders. It returns a tuple containing a list of adapted extension instances with resolved code references, a boolean flag indicating whether the resolution is complete, and a list of errors detected during the resolution.
225225

@@ -364,7 +364,7 @@ A hook that provides a list of user-selected active TableColumns.
364364
TableColumns
365365

366366
|`\{boolean} [options.showNamespaceOverride]` |(optional) If true, a
367-
namespace column will be included, regardless of column management
367+
namespace column is included, regardless of column management
368368
selections
369369

370370
|`\{string} [options.columnManagementID]` |(optional) A unique ID
@@ -757,7 +757,7 @@ const Component: React.FC = () => {
757757
|===
758758
|Parameter Name |Description
759759
|`initResources` |Resources must be watched as key-value pair,
760-
wherein key will be unique to resource and value will be options needed
760+
wherein key is unique to resource and value is options needed
761761
to watch for the respective resource.
762762
|===
763763

@@ -837,8 +837,8 @@ model. In case of failure, the promise gets rejected with HTTP error response.
837837

838838
|`options.model` |k8s model
839839

840-
|`options.name` |The name of the resource, if not provided then it will
841-
look for all the resources matching the model.
840+
|`options.name` |The name of the resource, if not provided then it
841+
looks for all the resources matching the model.
842842

843843
|`options.ns` | The namespace to look into, should not be specified
844844
for cluster-scoped resources.
@@ -949,7 +949,7 @@ request headers, method, redirect, etc. See link:{power-bi-url}[Interface Reques
949949

950950

951951
|`options.json` |Can control garbage collection of resources
952-
explicitly if provided else will default to model's "propagationPolicy".
952+
explicitly if provided or else it defaults to the model's "propagationPolicy".
953953
|===
954954

955955
[discrete]
@@ -990,7 +990,7 @@ Provides apiVersion for a k8s model.
990990
[discrete]
991991
== `getGroupVersionKindForResource`
992992

993-
Provides a group, version, and kind for a resource. It returns the group, version, kind for the provided resource. If the resource does not have an API group, group "core" will be returned. If the resource has an invalid apiVersion, then it will throw an Error.
993+
Provides a group, version, and kind for a resource. It returns the group, version, kind for the provided resource. If the resource does not have an API group, group "core" is returned. If the resource has an invalid apiVersion, then it throws an Error.
994994

995995
[cols=",",options="header",]
996996
|===
@@ -1001,7 +1001,7 @@ Provides a group, version, and kind for a resource. It returns the group, versio
10011001
[discrete]
10021002
== `getGroupVersionKindForModel`
10031003

1004-
Provides a group, version, and kind for a k8s model. This returns the group, version, kind for the provided model. If the model does not have an apiGroup, group "core" will be returned.
1004+
Provides a group, version, and kind for a k8s model. This returns the group, version, kind for the provided model. If the model does not have an apiGroup, group "core" is returned.
10051005

10061006
[cols=",",options="header",]
10071007
|===
@@ -1294,7 +1294,7 @@ the editor. This prop is used only during the initial render
12941294

12951295
|`header` |Add a header on top of the YAML editor
12961296

1297-
|`onSave` |Callback for the Save button. Passing it will override the
1297+
|`onSave` |Callback for the Save button. Passing it overrides the
12981298
default update performed on the resource by the editor
12991299
|===
13001300

@@ -1404,7 +1404,7 @@ Component that allows to receive contributions from other plugins for the `conso
14041404
[discrete]
14051405
== `NamespaceBar`
14061406

1407-
A component that renders a horizontal toolbar with a namespace dropdown menu in the leftmost position. Additional components can be passed in as children and will be rendered to the right of the namespace dropdown. This component is designed to be used at the top of the page. It should be used on pages where the user needs to be able to change the active namespace, such as on pages with k8s resources.
1407+
A component that renders a horizontal toolbar with a namespace dropdown menu in the leftmost position. Additional components can be passed in as children and is rendered to the right of the namespace dropdown. This component is designed to be used at the top of the page. It should be used on pages where the user needs to be able to change the active namespace, such as on pages with k8s resources.
14081408

14091409
.Example
14101410
[source,text]
@@ -1429,7 +1429,7 @@ namespace option is selected. It accepts the new namespace in the form
14291429
of a string as its only argument. The active namespace is updated
14301430
automatically when an option is selected, but additional logic can be
14311431
applied via this function. When the namespace is changed, the namespace
1432-
parameter in the URL will be changed from the previous namespace to the
1432+
parameter in the URL is changed from the previous namespace to the
14331433
newly selected namespace.
14341434

14351435
|`isDisabled` |(optional) A boolean flag that disables the namespace
@@ -1493,14 +1493,14 @@ A component that renders a graph of the results from a Prometheus PromQL query a
14931493
|`customDataSource` |(optional) Base URL of an API endpoint that handles PromQL queries. If provided, this is used instead of the default API for fetching data.
14941494
|`defaultSamples` |(optional) The default number of data samples plotted for each data series. If there are many data series, QueryBrowser might automatically pick a lower number of data samples than specified here.
14951495
|`defaultTimespan` |(optional) The default timespan for the graph in milliseconds - defaults to 1,800,000 (30 minutes).
1496-
|`disabledSeries` |(optional) Disable (don't display) data series with these exact label / value pairs.
1496+
|`disabledSeries` |(optional) Disable (do not display) data series with these exact label / value pairs.
14971497
|`disableZoom` |(optional) Flag to disable the graph zoom controls.
14981498
|`filterLabels` |(optional) Optionally filter the returned data series to only those that match these label / value pairs.
14991499
|`fixedEndTime` |(optional) Set the end time for the displayed time range rather than showing data up to the current time.
15001500
|`formatSeriesTitle` |(optional) Function that returns a string to use as the title for a single data series.
15011501
|`GraphLink` |(optional) Component for rendering a link to another page (for example getting more information about this query).
15021502
|`hideControls` |(optional) Flag to hide the graph controls for changing the graph timespan, and so on.
1503-
|`isStack` |(optional) Flag to display a stacked graph instead of a line graph. If showStackedControl is set, it will still be possible for the user to switch to a line graph.
1503+
|`isStack` |(optional) Flag to display a stacked graph instead of a line graph. If showStackedControl is set, it is still possible for the user to switch to a line graph.
15041504
|`namespace` |(optional) If provided, data is only returned for this namespace (only series that have this namespace label).
15051505
|`onZoom` |(optional) Callback called when the graph is zoomed.
15061506
|`pollInterval` |(optional) If set, determines how often the graph is updated to show the latest data (in milliseconds).
@@ -1533,7 +1533,7 @@ const PodAnnotationsButton = ({ pod }) => {
15331533
|===
15341534

15351535
.Returns
1536-
A function which will launch a modal for editing a resource's annotations.
1536+
A function which launches a modal for editing a resource's annotations.
15371537

15381538
[discrete]
15391539
== `useDeleteModal`
@@ -1561,7 +1561,7 @@ const DeletePodButton = ({ pod }) => {
15611561
|===
15621562

15631563
.Returns
1564-
A function which will launch a modal for deleting a resource.
1564+
A function which launches a modal for deleting a resource.
15651565

15661566
[discrete]
15671567
== `useLabelsModel`
@@ -1585,7 +1585,7 @@ const PodLabelsButton = ({ pod }) => {
15851585
|===
15861586

15871587
.Returns
1588-
A function which will launch a modal for editing a resource's labels.
1588+
A function which launches a modal for editing a resource's labels.
15891589

15901590
[discrete]
15911591
== `useActiveNamespace`

modules/gitops-release-notes-1-4-0.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The current release adds the following improvements.
2424

2525
* As an administrative user, when you give Argo CD access to a namespace by using the `argocd.argoproj.io/managed-by` label, it assumes namespace-admin privileges. These privileges are an issue for administrators who provide namespaces to non-administrators, such as development teams, because the privileges enable non-administrators to modify objects such as network policies.
2626
+
27-
With this update, administrators can configure a common cluster role for all the managed namespaces. In role bindings for the Argo CD application controller, the Operator refers to the `CONTROLLER_CLUSTER_ROLE` environment variable. In role bindings for the Argo CD server, the Operator refers to the `SERVER_CLUSTER_ROLE` environment variable. If these environment variables contain custom roles, the Operator doesn't create the default admin role. Instead, it uses the existing custom role for all managed namespaces. link:https://issues.redhat.com/browse/GITOPS-1290[GITOPS-1290]
27+
With this update, administrators can configure a common cluster role for all the managed namespaces. In role bindings for the Argo CD application controller, the Operator refers to the `CONTROLLER_CLUSTER_ROLE` environment variable. In role bindings for the Argo CD server, the Operator refers to the `SERVER_CLUSTER_ROLE` environment variable. If these environment variables contain custom roles, the Operator does not create the default admin role. Instead, it uses the existing custom role for all managed namespaces. link:https://issues.redhat.com/browse/GITOPS-1290[GITOPS-1290]
2828

2929
* With this update, the *Environments* page in the {product-title} *Developer* perspective displays a broken heart icon to indicate degraded resources, excluding ones whose status is `Progressing`, `Missing`, and `Unknown`. The console displays a yellow yield sign icon to indicate out-of-sync resources. link:https://issues.redhat.com/browse/GITOPS-1307[GITOPS-1307]
3030

@@ -37,9 +37,9 @@ The following issues have been resolved in the current release:
3737

3838
* Before this update, setting a resource quota in the namespace of the Argo CD custom resource might cause the setup of the Red Hat SSO (RH SSO) instance to fail. This update fixes this issue by setting a minimum resource request for the RH SSO deployment pods. link:https://issues.redhat.com/browse/GITOPS-1297[GITOPS-1297]
3939

40-
* Before this update, if you changed the log level for the `argocd-repo-server` workload, the Operator didn't reconcile this setting. The workaround was to delete the deployment resource so that the Operator recreated it with the new log level. With this update, the log level is correctly reconciled for existing `argocd-repo-server` workloads. link:https://issues.redhat.com/browse/GITOPS-1387[GITOPS-1387]
40+
* Before this update, if you changed the log level for the `argocd-repo-server` workload, the Operator did not reconcile this setting. The workaround was to delete the deployment resource so that the Operator recreated it with the new log level. With this update, the log level is correctly reconciled for existing `argocd-repo-server` workloads. link:https://issues.redhat.com/browse/GITOPS-1387[GITOPS-1387]
4141

42-
* Before this update, if the Operator managed an Argo CD instance that lacked the `.data` field in the `argocd-secret` Secret, the Operator on that instance crashed. This update fixes the issue so that the Operator doesn't crash when the `.data` field is missing. Instead, the secret regenerates and the `gitops-operator-controller-manager` resource is redeployed. link:https://issues.redhat.com/browse/GITOPS-1402[GITOPS-1402]
42+
* Before this update, if the Operator managed an Argo CD instance that lacked the `.data` field in the `argocd-secret` Secret, the Operator on that instance crashed. This update fixes the issue so that the Operator does not crash when the `.data` field is missing. Instead, the secret regenerates and the `gitops-operator-controller-manager` resource is redeployed. link:https://issues.redhat.com/browse/GITOPS-1402[GITOPS-1402]
4343

4444
* Before this update, the `gitopsservice` service was annotated as an internal object. This update removes the annotation so you can update or delete the default Argo CD instance and run GitOps workloads on infrastructure nodes by using the UI. link:https://issues.redhat.com/browse/GITOPS-1429[GITOPS-1429]
4545

0 commit comments

Comments
 (0)