diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc index 511cf1b75b..9ac13888fc 100644 --- a/CONTRIBUTING.adoc +++ b/CONTRIBUTING.adoc @@ -46,7 +46,7 @@ To understand the nature of topics, see the link:https://redhat-documentation.gi == Project structure, branches and workflows . link:https://github.com/eclipse-che/che-docs/tree/main[main branch] - hosts documentation for next version of Che. -. release branches (e.g. link:https://github.com/eclipse-che/che-docs/tree/7.90.x[7.90.x]) - hosts documentations for stable versions of Che. +. release branches (for example link:https://github.com/eclipse-che/che-docs/tree/7.90.x[7.90.x]) - hosts documentations for stable versions of Che. . link:https://github.com/eclipse-che/che-docs/tree/publication[publication] branch stores published documents. . link:https://github.com/eclipse-che/che-docs/tree/publication-builder[publication-builder] branch hosts a structure and a workflow for publishing documentation to the link:https://github.com/eclipse-che/che-docs/tree/publication[publication] branch. diff --git a/modules/administration-guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc b/modules/administration-guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc index f6ca536024..fc829f216a 100644 --- a/modules/administration-guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc +++ b/modules/administration-guide/examples/snip_che-steps-to-build-custom-plugin-registry-in-workspace.adoc @@ -1,6 +1,6 @@ ... Start a workspace using the link:https://github.com/eclipse-che/che-plugin-registry[plugin registry repository]. -... Open a terminal and check out the Git tag that corresponds to your {prod-short} version (e.g., `7.87.0`): +... Open a terminal and check out the Git tag that corresponds to your {prod-short} version (for example, `7.87.0`): + [source] ---- diff --git a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc b/modules/administration-guide/pages/calculating-che-resource-requirements.adoc index c6a7534f38..9c1b4e3b7d 100644 --- a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc +++ b/modules/administration-guide/pages/calculating-che-resource-requirements.adoc @@ -52,7 +52,7 @@ The `tools` component of the devfile defines the following requests and limits: cpuLimit: 500m ---- -** IMPORTANT: Additional memory and CPU will be added implicitly for a JetBrains IDE (e.g. IntelliJ IDEA Ultimate): +** IMPORTANT: Additional memory and CPU will be added implicitly for a JetBrains IDE (for example IntelliJ IDEA Ultimate): + [source,yaml,subs="+attributes,+quotes,macros"] ---- diff --git a/modules/administration-guide/pages/concealing-editors.adoc b/modules/administration-guide/pages/concealing-editors.adoc index 6b32b36e7b..5246256163 100644 --- a/modules/administration-guide/pages/concealing-editors.adoc +++ b/modules/administration-guide/pages/concealing-editors.adoc @@ -6,7 +6,7 @@ [id="concealing-editors"] = Concealing editors -Learn how to conceal {prod-short} editors. This is useful when you want to hide selected editors from the Dashboard UI, e.g. hide the IntelliJ IDEA Ultimate and have only Visual Studio Code - Open Source visible. +Learn how to conceal {prod-short} editors. This is useful when you want to hide selected editors from the Dashboard UI, for example hide the IntelliJ IDEA Ultimate and have only Visual Studio Code - Open Source visible. .Prerequisites diff --git a/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc b/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc index a01862b6fa..3f59d912e7 100644 --- a/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc +++ b/modules/administration-guide/pages/deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc @@ -26,7 +26,7 @@ $ {orch-cli} create configmap che-git-self-signed-cert \ --from-literal=githost=____ -n {prod-namespace} <2> ---- <1> Path to the self-signed certificate. -<2> Optional parameter to specify the Git server URL e.g. `https://git.example.com:8443`. When omitted, the self-signed certificate is used for all repositories over HTTPS. +<2> Optional parameter to specify the Git server URL for example `https://git.example.com:8443`. When omitted, the self-signed certificate is used for all repositories over HTTPS. + [NOTE] ==== diff --git a/modules/administration-guide/pages/running-at-scale.adoc b/modules/administration-guide/pages/running-at-scale.adoc index 2f0516c556..866884f3e6 100644 --- a/modules/administration-guide/pages/running-at-scale.adoc +++ b/modules/administration-guide/pages/running-at-scale.adoc @@ -136,7 +136,7 @@ a stripped-down copy of its CSV is created in every {namespace} the Operator is These stripped-down CSVs are known as “Copied CSVs” and communicate to users which controllers are actively reconciling resource events in a given namespace. On especially large clusters, with namespaces and installed operators tending in the hundreds or thousands, -Copied CSVs consume an unsustainable amount of resources; e.g., OLM memory usage, cluster etcd limits, +Copied CSVs consume an unsustainable amount of resources; for example, OLM memory usage, cluster etcd limits, networking, etc. To eliminate the CSVs copied to every namespace, configure the `OLMConfig` object accordingly: [source,yaml] diff --git a/modules/administration-guide/pages/security-best-practices.adoc b/modules/administration-guide/pages/security-best-practices.adoc index f9dbc56922..4c5c1de16d 100644 --- a/modules/administration-guide/pages/security-best-practices.adoc +++ b/modules/administration-guide/pages/security-best-practices.adoc @@ -240,7 +240,7 @@ By default, {prod} includes the embedded Open VSX registry which contains a limited set of extensions for the Microsoft Visual Studio Code - Open Source editor. -Alternatively, cluster administrators can specify a different plugin registry in the Custom Resource, e.g. +Alternatively, cluster administrators can specify a different plugin registry in the Custom Resource, for example https://open-vsx.org that contains thousands of extensions. They can also build a custom Open VSX registry. include::example$snip_che-managing-extensions.adoc[] @@ -253,7 +253,7 @@ Installing extra extensions increases potential risks. To minimize these risks, .Secrets Keep sensitive data stored as {kubernetes} secrets in the users’ -namespaces confidential (e.g. Personal Access Tokens (PAT), and SSH keys). +namespaces confidential (for example Personal Access Tokens (PAT), and SSH keys). .Git repositories diff --git a/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc b/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc index ddea071b53..5b5c495659 100644 --- a/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc +++ b/modules/administration-guide/partials/proc_adding-or-removing-extensions-in-the-embedded-open-vsx-registry-instance.adoc @@ -49,7 +49,7 @@ If the extension publisher is unavailable or unwilling to publish the extension For IBM Power (`ppc64le`) and IBM Z (`s390x`), the custom plugin registry is expected to be built locally on the corresponding architecture. ==== -... Login to your {prod-short} instance as an administrator. +... Log in to your {prod-short} instance as an administrator. include::example$snip_{project-context}-steps-to-build-custom-plugin-registry-in-workspace.adoc[] diff --git a/modules/end-user-guide/pages/devfile-introduction.adoc b/modules/end-user-guide/pages/devfile-introduction.adoc index f1b2d2117c..3400c3cb8d 100644 --- a/modules/end-user-guide/pages/devfile-introduction.adoc +++ b/modules/end-user-guide/pages/devfile-introduction.adoc @@ -12,7 +12,7 @@ link:https://devfile.io/[Devfiles] are `yaml` text files used for development en [WARNING] ==== -Some images can not be used as-is for defining Cloud Development Environment since Visual Studio Code - Open Source ("Code - OSS") can not be started in the containers with missing `openssl` and `libbrotli`. Missing libraries should be explicitly installed on the Dockerfile level e.g. `RUN yum install compat-openssl11 libbrotli` +Some images can not be used as-is for defining Cloud Development Environment since Visual Studio Code - Open Source ("Code - OSS") can not be started in the containers with missing `openssl` and `libbrotli`. Missing libraries should be explicitly installed on the Dockerfile level for example `RUN yum install compat-openssl11 libbrotli` ==== .Devfile and Universal Developer Image diff --git a/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc b/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc index e27fb2a75d..bcf5f14d37 100644 --- a/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc +++ b/modules/end-user-guide/pages/using-a-git-provider-access-token.adoc @@ -121,17 +121,20 @@ EOF ==== If you are using Azure DevOps Server, you must also modify the xref:mounting-git-configuration.adoc[workspace's gitconfig] with the following section: -``` -[http] + +[source,http] +---- extraheader = "Authorization: Basic " -``` +---- To generate the key-value pair, use the following command: -``` + +[source,commandline] +---- echo -n "extraheader = \"Authorization: Basic "$(printf ":%s" | base64)\" -``` +---- see link:https://learn.microsoft.com/en-us/azure/devops/repos/git/auth-overview?view=azure-devops&tabs=Linux#personal-access-tokens[the documentation page] for more information. -The `extraheader` configuration is needed for remote git operations to Azure Devops Server, e.g. `git clone`. This authorization method has a higher priority over the git credentials store, and as a result, the remote operations to other Git providers will fail. +The `extraheader` configuration is needed for remote git operations to Azure Devops Server, for example `git clone`. This authorization method has a higher priority over the git credentials store, and as a result, the remote operations to other Git providers will fail. ==== .Verification