From d74d2ff877f18918b60d1a19b868136f9ef7d3d8 Mon Sep 17 00:00:00 2001 From: deerskindoll Date: Tue, 6 Feb 2024 13:47:53 +0100 Subject: [PATCH] Vale errors fix --- .vale.ini | 6 +++--- code_review_checklist.adoc | 4 ++-- .../snip_che-upgrading-the-chectl-management-tool.adoc | 2 +- .../pages/configuring-storage-sizes.adoc | 2 +- modules/administration-guide/pages/user-workspaces.adoc | 2 +- .../authenticating-to-a-git-server-from-a-workspace.adoc | 4 ++++ .../pages/requesting-persistent-storage-for-workspaces.adoc | 4 ++++ .../using-credentials-and-configurations-in-workspaces.adoc | 4 ++++ .../proc_requesting-persistent-storage-in-a-pvc.adoc | 2 +- 9 files changed, 21 insertions(+), 9 deletions(-) diff --git a/.vale.ini b/.vale.ini index bf729803f2..9ca66e0756 100644 --- a/.vale.ini +++ b/.vale.ini @@ -1,5 +1,5 @@ # Vale configuration file for `che-docs` repository. -# See: https://docs.errata.ai/vale/config +# See: https://vale.sh/docs/topics/config/ # The relative path to the folder containing linting rules (styles). StylesPath = .vale/styles @@ -16,7 +16,7 @@ Packages = https://github.com/redhat-documentation/vale-at-red-hat/releases/late MinAlertLevel = warning # IgnoredScopes specifies inline-level HTML tags to ignore. -# These tags may occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts. +# These tags can occur in an active scope (unlike SkippedScopes, skipped entirely) but their content still will not raise any alerts. # Default: ignore `code` and `tt`. IgnoredScopes = code, tt, img, url, a, body.id # SkippedScopes specifies block-level HTML tags to ignore. Ignore any content in these scopes. @@ -24,7 +24,7 @@ IgnoredScopes = code, tt, img, url, a, body.id # For AsciiDoc: by default, listingblock, and literalblock. SkippedScopes = script, style, pre, figure, code, tt, blockquote, listingblock, literalblock -# Rules for matching file types. See: https://docs.errata.ai/vale/scoping +# Rules for matching file types. See: https://vale.sh/docs/topics/scoping/ [[!.]*.adoc] # Styles to load, located in the `StylesPath` folder: diff --git a/code_review_checklist.adoc b/code_review_checklist.adoc index f0cb483853..320347b155 100644 --- a/code_review_checklist.adoc +++ b/code_review_checklist.adoc @@ -27,9 +27,9 @@ The author and the reviewers validate the content of a pull request with this ad * [ ] Builds on https://workspaces.openshift.com[Eclipse Che hosted by Red Hat]. * [ ] *`Validate language on files added or modified`* step reports no vale warnings. -## In depth language review checklist +## In-depth language review checklist -The technical writer reviewers validate the language with this additional in depth checklist. We do recognize the subjectivity of some of these objectives. +The technical writer reviewers validate the language with this additional in-depth checklist. We do recognize the subjectivity of some of these objectives. - [ ] Content is appropriate for the intended audience. - [ ] Downstream friendly: correct use of attributes, `ifdef` statements, examples. diff --git a/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc b/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc index 51b335a0ff..e171617f41 100644 --- a/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc +++ b/modules/administration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc @@ -24,7 +24,7 @@ Two update channels are available for `{prod-cli}`: `stable` and `next`. * `stable` is for the latest released version of {prod}. * `next` is updated after each activity in the `main` branch of the link:https://github.com/che-incubator/{prod-cli}[{prod-cli} repository]. -To move to a different channel, invoke the update with the name of the channel as an optional argument. +To move to a different channel, start the update with the name of the channel as an optional argument. [subs="+attributes"] ---- diff --git a/modules/administration-guide/pages/configuring-storage-sizes.adoc b/modules/administration-guide/pages/configuring-storage-sizes.adoc index b60b32bb16..cf403a9325 100644 --- a/modules/administration-guide/pages/configuring-storage-sizes.adoc +++ b/modules/administration-guide/pages/configuring-storage-sizes.adoc @@ -53,4 +53,4 @@ spec: ---- <1> Select the storage strategy: `per-user` or `per-workspace` or `ephemeral`. Note: the `ephemeral` storage strategy does not use persistent storage, therefore you cannot configure its storage size or other PVC-related attributes. <2> Specify a claim size on the next line or omit the next line to set the default claim size value. The specified claim size is only used when you select this storage strategy. -<3> The claim size must be specified as a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[{kubernetes} resource quantity]. The available quantity units include: `Ei`, `Pi`, `Ti`, `Gi`, `Mi` and `Ki`. \ No newline at end of file +<3> The claim size must be specified as a link:https://kubernetes.io/docs/reference/kubernetes-api/common-definitions/quantity/[Kubernetes resource quantity]. The available quantity units include: `Ei`, `Pi`, `Ti`, `Gi`, `Mi` and `Ki`. \ No newline at end of file diff --git a/modules/administration-guide/pages/user-workspaces.adoc b/modules/administration-guide/pages/user-workspaces.adoc index ae788e9041..415de3ce89 100644 --- a/modules/administration-guide/pages/user-workspaces.adoc +++ b/modules/administration-guide/pages/user-workspaces.adoc @@ -31,7 +31,7 @@ A workspace is one {orch-name} Deployment containing the workspace containers an * Secrets * Persistent Volumes (PV) -A {prod-short} workspace contains the source code of the projects, persisted in a {platforms-name} Persistent Volume (PV). Microservices have read-write access to this shared directory. +A {prod-short} workspace contains the source code of the projects, persisted in a {platforms-name} Persistent Volume (PV). Microservices have read/write access to this shared directory. Use the devfile v2 format to specify the tools and runtime applications of a {prod-short} workspace. diff --git a/modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc b/modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc index 4e1ce7cb93..377d6177a3 100644 --- a/modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc +++ b/modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc @@ -7,6 +7,8 @@ [id="authenticating-to-a-git-server-from-a-workspace"] = Authenticating to a Git server from a workspace +pass:[] + In a workspace, you can run Git commands that require user authentication like cloning a remote private Git repository or pushing to a remote public or private Git repository. User authentication to a Git server from a workspace is configured by the administrator or, in some cases, by the individual user: @@ -15,6 +17,8 @@ User authentication to a Git server from a workspace is configured by the admini * As a workaround, some users create and apply their own {kubernetes} Secrets for their personal xref:using-a-git-provider-access-token.adoc[Git-provider access tokens] or link:https://github.com/devfile/devworkspace-operator/blob/main/docs/additional-configuration.adoc#configuring-devworkspaces-to-use-ssh-keys-for-git-operations[configure SSH keys for Git operations]. +pass:[] + .Additional resources * xref:administration-guide:configuring-oauth-for-git-providers.adoc[Administration Guide: Configuring OAuth for Git providers] * xref:using-a-git-provider-access-token.adoc[User Guide: Using a Git-provider access token] diff --git a/modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc b/modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc index 9e2c2fef97..4a1c1d0415 100644 --- a/modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc +++ b/modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc @@ -7,12 +7,16 @@ [id="requesting-persistent-storage-for-workspaces"] = Requesting persistent storage for workspaces +pass:[] + {prod-short} workspaces and workspace data are ephemeral and are lost when the workspace stops. To preserve the workspace state in persistent storage while the workspace is stopped, request a {kubernetes} PersistentVolume (PV) for the `{devworkspace}` containers in the {orch-name} cluster of your organization's {prod-short} instance. You can request a PV by using the devfile or a {kubernetes} PersistentVolumeClaim (PVC). +pass:[] + An example of a PV is the `/projects/` directory of a workspace, which is mounted by default for non-ephemeral workspaces. Persistent Volumes come at a cost: attaching a persistent volume slows workspace startup. diff --git a/modules/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc b/modules/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc index efc7bd2a17..833c81b385 100644 --- a/modules/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc +++ b/modules/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc @@ -7,6 +7,8 @@ [id="using-credentials-and-configurations-in-workspaces"] = Using credentials and configurations in workspaces +pass:[] + You can use your credentials and configurations in your workspaces. To do so, mount your credentials and configurations to the `{devworkspace}` containers in the {orch-name} cluster of your organization's {prod-short} instance: @@ -19,6 +21,8 @@ If you need to allow the `{devworkspace}` Pods in the cluster to access containe The mounting process uses the standard {kubernetes} mounting mechanism and requires applying additional labels and annotations to your existing resources. Resources are mounted when starting a new workspace or restarting an existing one. +pass:[] + You can create permanent mount points for various components: * Maven configuration, such as the link:https://maven.apache.org/settings.html[user-specific] `settings.xml` file diff --git a/modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc b/modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc index 1bb6159604..a5d8cc2b74 100644 --- a/modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc +++ b/modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc @@ -41,7 +41,7 @@ Defaults to `/tmp/____`. | `controller.devfile.io/read-only:` | Set to `'true'` or `'false'` to specify whether the PVC is to be mounted as read-only. -Defaults to `'false'`, resulting in the PVC mounted as read-write. +Defaults to `'false'`, resulting in the PVC mounted as read/write. |=== .Mounting a read-only PVC