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.

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

fix: fixed Vale warnings (rhdevdocs-4580) #2533

Merged
merged 2 commits into from
Jan 18, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section describes how to configure link:https://kubernetes.io/docs/concepts

.Procedure

{prod-short} uses the `CHE_WORKSPACE_POD_NODE__SELECTOR` environment variable to configure `nodeSelector`. This variable may contain a set of comma-separated `key=value` pairs to form the nodeSelector rule, or `NULL` to disable it.
{prod-short} uses the `CHE_WORKSPACE_POD_NODE__SELECTOR` environment variable to configure `nodeSelector`. This variable can contain a set of comma-separated `key=value` pairs to form the nodeSelector rule, or `NULL` to disable it.

----
CHE_WORKSPACE_POD_NODE__SELECTOR=disktype=ssd,cpu=xlarge,[key=value]
Expand Down
12 changes: 6 additions & 6 deletions modules/administration-guide/pages/plugin-registry.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@
:page-aliases: plug-in-registry

[id="plugin-registry"]
= Plug-in registry
= Plugin registry

Each {prod-short} workspace starts with a specific editor and set of associated extensions.
The {prod-short} plugin registry provides the list of available editors and editor extensions.
A Devfile v2 describes each editor or extension.

The xref:dashboard.adoc[] is reading the content of the registry.

.Plug-in registries interactions with other components
image::architecture/{project-context}-plugin-registry-interactions.png[Plug-in registries interactions with other components]
.Plugin registries interactions with other components
image::architecture/{project-context}-plugin-registry-interactions.png[Plugin registries interactions with other components]

.Additional resources

* link:https://github.com/eclipse-che/che-plugin-registry/blob/main/che-editors.yaml[Editors definitions in the {prod-short} plugin registry repository]
* link:https://github.com/eclipse-che/che-plugin-registry/blob/main/che-theia-plugins.yaml[Plug-ins definitions in the {prod-short} plugin registry repository]
* link:https://eclipse-che.github.io/che-plugin-registry/main/index.json[Plug-in registry latest community version online instance]
* link:https://github.com/eclipse-che/che-plugin-registry/blob/main/che-editors.yaml[Editor definitions in the {prod-short} plugin registry repository]
* link:https://github.com/eclipse-che/che-plugin-registry/blob/main/che-theia-plugins.yaml[Plugin definitions in the {prod-short} plugin registry repository]
* link:https://eclipse-che.github.io/che-plugin-registry/main/index.json[Plugin registry latest community version online instance]
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To use Prometheus to collect, store, and query metrics about the {devworkspace}

.Procedure

. Create a ClusterRoleBinding to bind the ServiceAccount associated with Prometheus to the link:https://github.com/devfile/devworkspace-operator/blob/main/deploy/deployment/kubernetes/objects/devworkspace-controller-metrics-reader.ClusterRole.yaml[devworkspace-controller-metrics-reader] ClusterRole. For the xref:installing-prometheus-and-grafana.adoc[example monitoring stack], the name of the ServiceAccount to be be used is `prometheus`.
. Create a ClusterRoleBinding to bind the ServiceAccount associated with Prometheus to the link:https://github.com/devfile/devworkspace-operator/blob/main/deploy/deployment/kubernetes/objects/devworkspace-controller-metrics-reader.ClusterRole.yaml[devworkspace-controller-metrics-reader] ClusterRole. For the xref:installing-prometheus-and-grafana.adoc[example monitoring stack], the name of the ServiceAccount to be used is `prometheus`.
+
NOTE: Without the ClusterRoleBinding, you cannot access {devworkspace} metrics because access is protected with role-based access control (RBAC).
+
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ metadata:
----
====

The {orch-name} object may contain several items whose names must match the desired file name mounted into the container.
The {orch-name} object can contain several items whose names must match the desired file name mounted into the container.

.Example:
====
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Persistent Volumes come at a cost: attaching a persistent volume slows workspace

[WARNING]
====
Starting another, concurrently running workspace with a link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes[`ReadWriteOnce` PV] may fail.
Starting another, concurrently running workspace with a link:https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes[`ReadWriteOnce` PV] might fail.
====

.Additional resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Secure WebSocket connections improve confidentiality and also reliability becaus

.Prerequisites

* The WebSocket Secure (WSS) connections on port 443 must be available on the network. Firewall and proxy may need additional configuration.
* The WebSocket Secure (WSS) connections on port 443 must be available on the network. Firewall and proxy might need additional configuration.
* Use a supported web browser:
** Google Chrome
** Mozilla Firefox
Expand Down