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.

Sign up for GitHub

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: Monospace fix #2680

Closed
wants to merge 2 commits into from
Closed

fix: Monospace fix #2680

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d74d2ff
Vale errors fix
deerskindoll Feb 6, 2024
f89e7a8
monospace fix
deerskindoll Feb 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -16,15 +16,15 @@ 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.
# Default: ignore `script`, `style`, `pre`, and `figure`.
# 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:
Expand Down
4 changes: 2 additions & 2 deletions code_review_checklist.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion ...dministration-guide/examples/snip_che-upgrading-the-chectl-management-tool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/configuring-storage-sizes.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@
----
<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`.
<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`.

Check failure on line 56 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Kubernetes' rather than 'kubernetes'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Kubernetes' rather than 'kubernetes'.", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 56, "column": 56}}}, "severity": "ERROR"}

Check warning on line 56 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'io/docs'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'io/docs'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 56, "column": 67}}}, "severity": "WARNING"}

Check warning on line 56 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'api/common'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'api/common'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 56, "column": 96}}}, "severity": "WARNING"}

Check warning on line 56 in modules/administration-guide/pages/configuring-storage-sizes.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'definitions/quantity'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'definitions/quantity'", "location": {"path": "modules/administration-guide/pages/configuring-storage-sizes.adoc", "range": {"start": {"line": 56, "column": 107}}}, "severity": "WARNING"}
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/defining-the-list-of-images-to-pull.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The {image-puller-name-short} can pre-pull most images, including scratch images

. Gather a list of relevant container images to pull by navigating to the `pass:c,a,q[{prod-url}]/plugin-registry/v3/external_images.txt` URL.

. Determine images from the list for pre-pulling. For faster workspace startup times, consider pulling workspace related images such as `universal-developer-image`, che-code`, and `che-gateway`.
. Determine images from the list for pre-pulling. For faster workspace startup times, consider pulling workspace related images such as `universal-developer-image`, `che-code`, and `che-gateway`.

.Additional resources
* xref:installing-image-puller-on-openshift-using-the-web-console.adoc[]
Expand Down
2 changes: 1 addition & 1 deletion modules/administration-guide/pages/user-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
* 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.

Check warning on line 34 in modules/administration-guide/pages/user-workspaces.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'read/write'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'read/write'", "location": {"path": "modules/administration-guide/pages/user-workspaces.adoc", "range": {"start": {"line": 34, "column": 143}}}, "severity": "WARNING"}

Use the devfile v2 format to specify the tools and runtime applications of a {prod-short} workspace.

Expand Down
4 changes: 4 additions & 0 deletions modules/end-user-guide/pages/authenticating-to-a-git-server-from-a-workspace.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="authenticating-to-a-git-server-from-a-workspace"]
= Authenticating to a Git server from a workspace

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

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:
Expand All @@ -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:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

.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]
Expand Down
4 changes: 4 additions & 0 deletions modules/end-user-guide/pages/requesting-persistent-storage-for-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@
[id="requesting-persistent-storage-for-workspaces"]
= Requesting persistent storage for workspaces

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

{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:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

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.
Expand Down
4 changes: 4 additions & 0 deletions ...es/end-user-guide/pages/using-credentials-and-configurations-in-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
[id="using-credentials-and-configurations-in-workspaces"]
= Using credentials and configurations in workspaces

pass:[<!-- vale RedHat.CaseSensitiveTerms = NO -->]

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:
Expand All @@ -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:[<!-- vale RedHat.CaseSensitiveTerms = YES -->]

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
Expand Down
2 changes: 1 addition & 1 deletion modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
| `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.

Check warning on line 44 in modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'read/write'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'read/write'", "location": {"path": "modules/end-user-guide/partials/proc_requesting-persistent-storage-in-a-pvc.adoc", "range": {"start": {"line": 44, "column": 56}}}, "severity": "WARNING"}
|===

.Mounting a read-only PVC
Expand Down
Loading