docs: Fix language and links in the properties files. (#15)

* Fix language and links on properties files

* Update assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties

* Add {prod-short} definition

Author: themr0c

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/che.properties

@@ -11,6 +11,7 @@
 #
 
 # {orch-name}: Kubernetes or OpenShift
+# {prod-short}: Eclipse Che
 
 ### {prod-short} server
 
@@ -143,15 +144,15 @@ che.workspace.activity_cleanup_scheduler_initial_delay_s=60
 
 
 # Delay before first workspace idleness check job started to avoid
-# mass suspend if ws master was unavailable for period close to
+# mass suspend if {prod-short} server was unavailable for period close to
 # inactivity timeout.
 che.workspace.activity_check_scheduler_delay_s=180
 
 
-# Time period to delay the first execution of temporary workspaces cleanup job.
+# Time to delay the first execution of temporary workspaces cleanup job.
 che.workspace.cleanup_temporary_initial_delay_min=5
 
-# Time period delay between the termination of one execution and the commencement
+# Time to delay between the termination of one execution and the commencement
 # of the next execution of temporary workspaces cleanup job
 che.workspace.cleanup_temporary_period_min=180
 
@@ -332,7 +333,7 @@ che.infra.kubernetes.service_account_name=NULL
 # This property deprecates `che.infra.kubernetes.cluster_role_name`.
 che.infra.kubernetes.workspace_sa_cluster_roles=NULL
 
-# Defines time frame that limits the Kubernetes workspace start time
+# Defines wait time that limits the Kubernetes workspace start time.
 che.infra.kubernetes.workspace_start_timeout_min=8
 
 # Defines the timeout in minutes that limits the period for which Kubernetes Ingress become ready
@@ -371,7 +372,7 @@ che.infra.kubernetes.pvc.strategy=common
 # Necessary in some versions of {orch-name} as workspace subpath volume mounts are created with root permissions,
 # and therefore cannot be modified by workspaces running as a user (presents an error importing projects into a workspace in {prod-short}).
 # The default is `true`, but should be set to `false` if the version of {orch-name} creates subdirectories with user permissions.
-# Relevant issue: https://github.com/kubernetes/kubernetes/issues/41638
+# See: link:https://github.com/kubernetes/kubernetes/issues/41638[subPath in volumeMount is not writable for non-root users #41638]
 # the {prod-short} Operator that this property has effect only if the `common` PVC strategy used.
 che.infra.kubernetes.pvc.precreate_subpaths=true
 
@@ -385,8 +386,7 @@ che.infra.kubernetes.pvc.name=claim-che-workspace
 che.infra.kubernetes.pvc.storage_class_name=
 
 # Defines the size of Persistent Volume Claim of {prod-short} workspace.
-# Format described here:
-# https://docs.openshift.com/container-platform/latest/dev_guide/compute_resources.html#dev-compute-resources
+# See: link:https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html[Understanding persistent storage]
 che.infra.kubernetes.pvc.quantity=10Gi
 
 # Pod that is launched when performing persistent volume claim maintenance jobs on OpenShift
@@ -401,8 +401,7 @@ che.infra.kubernetes.pvc.jobs.memorylimit=250Mi
 # Defines Persistent Volume Claim access mode.
 # the {prod-short} Operator that for common PVC strategy changing of access mode affects the number of simultaneously running workspaces.
 # If the OpenShift instance running {prod-short} is using Persistent Volumes with RWX access mode, then a limit of running workspaces at the same time is bounded only by {prod-short} limits configuration: RAM, CPU, and so on.
-# Detailed information about access mode is described here:
-# https://docs.openshift.com/container-platform/latest/architecture/additional_concepts/storage.html#pv-access-modes
+# See: link:https://docs.openshift.com/container-platform/4.4/storage/understanding-persistent-storage.html[Understanding persistent storage]
 che.infra.kubernetes.pvc.access_mode=ReadWriteOnce
 
 # Defines if {prod-short} Server should wait workspaces Persistent Volume Claims to become bound after creating.
@@ -434,17 +433,17 @@ che.infra.kubernetes.pvc.wait_bound=true
 # to `%s` (see the `che.infra.kubernetes.ingress.path.rewrite_transform` property).
 #
 # See the Nginx ingress controller documentation for the explanation of how the ingress controller uses
-# the regular expression present in the ingress path and how it achieves the URL rewriting.
+# the regular expression available in the ingress path and how it achieves the URL rewriting.
 che.infra.kubernetes.ingress.annotations_json=NULL
 
-# Defines a "recipe" on how to declare the path of the ingress that should expose a server.
-# The "%s" represents the base public URL of the server and is guaranteed to end with a forward slash. This property
-# must be a valid input to the String.format() method and contain exactly one reference to "%s".
+# Defines a recipe on how to declare the path of the ingress that should expose a server.
+# The `%s` represents the base public URL of the server and is guaranteed to end with a forward slash. This property
+# must be a valid input to the `String.format()` method and contain exactly one reference to `%s`.
 #
 # See the description of the `che.infra.kubernetes.ingress.annotations_json` property to see how these two
 # properties interplay when specifying the ingress annotations and path.
 #
-# If not defined, this property defaults to "%s" (without the quotes) which means that the path is not transformed in
+# If not defined, this property defaults to `%s` (without the quotes) which means that the path is not transformed in
 # any way for use with the ingress controller.
 che.infra.kubernetes.ingress.path_transform=NULL
 
@@ -722,8 +721,8 @@ che.infra.kubernetes.async.storage.image=quay.io/eclipse/che-workspace-data-sync
 che.workspace.pod.node_selector=NULL
 
 # Optionally configures tolerations for workspace Pod. Format is a string representing a JSON Array of taint tolerations, 
-# or `NULL` to disable it. The objects contained in the array have to follow this 
-# link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#toleration-v1-core[spec]. 
+# or `NULL` to disable it. The objects contained in the array have to follow the 
+# link:https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.20/#toleration-v1-core[toleration v1 core specifications]. 
 # Example: `[{"effect":"NoExecute","key":"aNodeTaint","operator":"Equal","value":"aValue"}]`
 che.workspace.pod.tolerations_json=NULL
 

assembly/assembly-wsmaster-war/src/main/webapp/WEB-INF/classes/che/multiuser.properties

@@ -18,10 +18,10 @@
 # getByKey, getByNameSpace, stopWorkspaces, and getResourcesInformation.
 # These are not given to admins by default and these permissions allow
 # admins gain visibility to any workspace along with naming themselves
-# with admin privileges to those workspaces.
+# with administrator privileges to those workspaces.
 che.system.super_privileged_mode=false
 
-# Grant system permission for 'che.admin.name' user. If the user already exists it'll happen on
+# Grant system permission for `che.admin.name` user. If the user already exists it'll happen on
 # component startup, if not - during the first login when user is persisted in the database.
 che.system.admin_name=admin
 
@@ -36,13 +36,13 @@ che.limits.workspace.env.ram=16gb
 # The length of time in milliseconds that a user is idle with their workspace when the system will
 # suspend the workspace and then stopping it. Idleness is the
 # length of time that the user has not interacted with the workspace, meaning that
-# one of our agents has not received interaction. Leaving a browser window open
+# one of the agents has not received interaction. Leaving a browser window open
 # counts toward idleness.
 che.limits.workspace.idle.timeout=1800000
 
 # The length of time in milliseconds that a workspace will run, regardless of activity, before
-# the system will suspend it.  Set this property if you want to automatically stop
-# workspaces after a period of time.  The default is zero, meaning that there is no
+# the system will suspend it. Set this property if you want to automatically stop
+# workspaces after a period of time. The default is zero, meaning that there is no
 # run timeout.
 che.limits.workspace.run.timeout=0
 
@@ -85,13 +85,12 @@ che.limits.organization.workspaces.run.count=-1
 
 ### Multi-user-specific OpenShift infrastructure configuration
 
-# Alias of the Openshift identity provider registered in Keycloak,
+# Alias of the OpenShift identity provider registered in Keycloak,
 # that should be used to create workspace OpenShift resources in
-# Openshift namespaces owned by the current Che user.
+# OpenShift namespaces owned by the current Che user.
 # Should be set to NULL if `che.infra.openshift.project`
 # is set to a non-empty value.
-# For more information see the following documentation:
-# https://www.keycloak.org/docs/3.3/server_admin/topics/identity-broker/social/openshift.html
+# See: link:https://www.keycloak.org/docs/latest/server_admin/#openshift-4[OpenShift identity provider]
 che.infra.openshift.oauth_identity_provider=NULL
 
 ### Keycloak configuration
@@ -109,22 +108,22 @@ che.keycloak.auth_internal_server_url=NULL
 # is used
 che.keycloak.realm=che
 
-# Keycloak client id in che.keycloak.realm that is used by dashboard, ide and cli to authenticate users
+# Keycloak client identifier in `che.keycloak.realm` to authenticate users in the dashboard, the IDE, and the CLI.
 che.keycloak.client_id=che-public
 
-# URL to access OSO oauth tokens
+# URL to access OSO OAuth tokens
 che.keycloak.oso.endpoint=NULL
 
-# URL to access Github oauth tokens
+# URL to access Github OAuth tokens
 che.keycloak.github.endpoint=NULL
 
-# The number of seconds to tolerate for clock skew when verifying exp or nbf claims.
+# The number of seconds to tolerate for clock skew when verifying `exp` or `nbf` claims.
 che.keycloak.allowed_clock_skew_sec=3
 
 # Use the OIDC optional `nonce` feature to increase security.
 che.keycloak.use_nonce=true
 
-# URL to the Keycloak Javascript adapter we want to use.
+# URL to the Keycloak Javascript adapter to use.
 # if set to NULL, then the default used value is
 # `${che.keycloak.auth_server_url}/js/keycloak.js`,
 # or `<che-server>/api/keycloak/OIDCKeycloak.js`
@@ -133,7 +132,7 @@ che.keycloak.js_adapter_url=NULL
 
 # Base URL of an alternate OIDC provider that provides
 # a discovery endpoint as detailed in the following specification
-# https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig
+# link:https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Obtaining OpenID Provider Configuration Information]
 che.keycloak.oidc_provider=NULL
 
 # Set to true when using an alternate OIDC provider that
@@ -149,27 +148,27 @@ che.keycloak.username_claim=NULL
 # Configuration of OAuth Authentication Service that can be used in "embedded" or "delegated" mode.
 # If set to "embedded", then the service work as a wrapper to Che's OAuthAuthenticator ( as in Single User mode).
 # If set to "delegated", then the service will use Keycloak IdentityProvider mechanism.
-# Runtime Exception wii be thrown, in case if this property is not set properly.
+# Runtime Exception `wii` be thrown, in case if this property is not set properly.
 che.oauth.service_mode=delegated
 
 # Configuration for enabling removing user from Keycloak server on removing user from Che database.
 # By default it's disabled. Can be enabled in some special cases when deleting a user in Che database
 # should execute removing related-user from Keycloak.
-# For correct work need to set admin username ${che.keycloak.admin_username} and password
+# For correct work need to set administrator username ${che.keycloak.admin_username} and password
 # ${che.keycloak.admin_password}.
 che.keycloak.cascade_user_removal_enabled=false
 
-# Keycloak admin username. Will be used for deleting user from Keycloak on removing user
+# Keycloak administrator username. Will be used for deleting user from Keycloak on removing user
 # from Che database. Make sense only in case ${che.keycloak.cascade_user_removal_enabled}
 # set to 'true'
 che.keycloak.admin_username=NULL
 
-# Keycloak admin password. Will be used for deleting user from Keycloak on removing user
+# Keycloak administrator password. Will be used for deleting user from Keycloak on removing user
 # from Che database. Make sense only in case ${che.keycloak.cascade_user_removal_enabled}
 # set to 'true'
 che.keycloak.admin_password=NULL
 
-# User name adjustment configuration. Che needs to use the usernames as part of K8s object names and labels and
+# User name adjustment configuration. Che needs to use the usernames as part of Kubernetes object names and labels and
 # therefore has stricter requirements on their format than the identity providers usually
 # allow (it needs them to be DNS-compliant). The adjustment is represented by comma-separated key-value pairs.
 # These are sequentially used as arguments to the String.replaceAll function on the original username.