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

docs: update content to reflect latest style guide #2522

Merged
merged 3 commits into from
Dec 15, 2022
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
Expand Up @@ -64,7 +64,7 @@ To check that, open Developer Tools in the browser and check for `vendors` in th

Providing enough CPU resources::
+
Plug-ins consume CPU resources. For example, when a plugin provides IntelliSense features, adding more CPU resources may lead to better performance.
Plug-ins consume CPU resources. For example, when a plugin provides IntelliSense features, adding more CPU resources can lead to better performance.
osslate marked this conversation as resolved.
Show resolved Hide resolved
+
Ensure the CPU settings in the devfile definition, `devfile.yaml`, are correct:
+
Expand Down
Expand Up @@ -9,7 +9,7 @@

Visiting a URL for starting a new workspace results in a new workspace according to the devfile and with a clone of the linked Git repository.

In some situations, you may need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter.
In some situations, you might need to have multiple workspaces that are duplicates in terms of the devfile and the linked Git repository. You can do this by visiting the same URL for starting a new workspace with a URL parameter.

The URL parameter for starting a duplicate workspace is `new`:

Expand Down
Expand Up @@ -9,7 +9,7 @@

When you visit a URL for starting a new workspace, {prod-short} searches the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. The devfile in the linked Git repository must follow this file-naming convention.

In some situations, you may need to specify a different, unconventional file name for the devfile.
In some situations, you might need to specify a different, unconventional file name for the devfile.

The URL parameter for specifying an unconventional file name of the devfile is `df=__<filename>__.yaml`:

Expand Down
Expand Up @@ -9,7 +9,7 @@

When you visit a URL for starting a new workspace, {prod-short} searches the root directory of the linked Git repository for a devfile with the file name `.devfile.yaml` or `devfile.yaml`. The file path of the devfile in the linked Git repository must follow this path convention.

In some situations, you may need to specify a different, unconventional file path for the devfile in the linked Git repository.
In some situations, you might need to specify a different, unconventional file path for the devfile in the linked Git repository.

The URL parameter for specifying an unconventional file path of the devfile is `devfilePath=__<relative_file_path>__`:

Expand Down
@@ -1,7 +1,7 @@
[id="requesting-persistent-storage-in-a-pvc"]
= Requesting persistent storage in a PVC

You may opt to apply a PersistentVolumeClaim (PVC) to request a PersistentVolume (PV) for your workspaces in the following cases:
You can opt to apply a PersistentVolumeClaim (PVC) to request a PersistentVolume (PV) for your workspaces in the following cases:

* Not all developers of the project need the PV.
* The PV lifecycle goes beyond the lifecycle of a single workspace.
Expand Down
2 changes: 1 addition & 1 deletion modules/overview/pages/introduction-to-eclipse-che.adoc
Expand Up @@ -78,7 +78,7 @@ To achieve those core goals, {prod} provides:

=== Workspace model

{prod-short} defines the workspace to be the project code files and all the dependencies necessary to edit, build, run, and debug them. {prod-short} treats the IDE and the development runtime as dependencies of the workspace. These items are embedded and always included with the workspace. This differentiates {prod-short} from classical workspace definitions, which may include the project code, but require the developer to bind their IDE to their workstation and use it to provide a runtime locally.
{prod-short} defines the workspace to be the project code files and all the dependencies necessary to edit, build, run, and debug them. {prod-short} treats the IDE and the development runtime as dependencies of the workspace. These items are embedded and always included with the workspace. This differentiates {prod-short} from classical workspace definitions, which can include the project code, but require the developer to bind their IDE to their workstation and use it to provide a runtime locally.

Workspaces are isolated from one another and are responsible for managing the lifecycle of their components.

Expand Down